library

The main UI5 control library, with responsive controls that can be used in touch devices as well as desktop browsers.

Namespaces & Classes

ActionListItemThe sap.m.ActionListItem can be used like a button to fire actions when pressed.

ActionSelectThe ActionSelect control provides a list of predefined items that allows end users to choose options and additionally trigger some actions.

ActionSheetActionSheet is a special kind of control which contains one or more sap.m.Button(s) and the ActionSheet will be closed when one of the buttons is tapped.

AppApp is the root element of a UI5 mobile application.

BackgroundDesignAvailable Background Design.

BackgroundHelperHelper for rendering themable background.

BarThe Bar control can be used as a header, sub-header and a footer in a page.

BarDesignTypes of the Bar design

BreadcrumbsEnables users to navigate between items by providing a list of links to previous steps in the user's navigation path.

BusyDialogBusyDialog is used to indicate that the system is busy and the user has to wait.

BusyIndicatorControl to indicate that the system is busy with some task and the user has to wait.

ButtonEnables users to trigger actions.

ButtonTypeDifferent types for a button (predefined types)

CarouselThe 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.

CheckBoxThe CheckBox control allows the user to select one or multiple items from a list.

ColumnThe sap.m.Column allows to define column specific properties that will be applied when rendering the sap.m.Table.

ColumnListItemsap.m.ColumnListItem can be used with the cells aggregation to create rows for the sap.m.Table control.

ComboBoxThe sap.m.ComboBox control combines a dropdown list with items and a text field with a button, allowing the user to either type a value directly or choose from the list of existing items.

ComboBoxBaseAn abstract class for combo boxes.

ComboBoxTextFieldThe sap.m.ComboBoxTextField.

CustomListItemThis control with a content aggregation can be used to customize standard list items that we don't provide.

CustomTileUse the CustomTile control to display application specific content in the Tile control.

DatePickerThis is a date input control with a calendar as date picker.

DateRangeSelectionThis is a date range input control with a calendar as date picker.

DateTimeInputAllows end users to interact with date and/or time and select from a date and/or time pad.

DateTimeInputTypeA subset of DateTimeInput types that fit to a simple API returning one string.

DateTimePickerThis is a date input control with a calendar and a time selector as date time picker.

DeviationIndicatorEnum of the available deviation markers for the NumericContent control.

DialogThe Dialog control is used to interrupt the current processing of an application to prompt the user for information or a response.

DialogTypeEnum for the type of sap.m.Dialog control.

DisplayListItemsap.m.DisplayListItem can be used to represent a label and a value.

DraftIndicatorA draft indicator is sap.m.Label.

DraftIndicatorStateEnum for the state of sap.m.DraftIndicator control.

FacetFilterOverview

The sap.m.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.

FacetFilterItemRepresents a value for the FacetFilterList control.

FacetFilterListFacetFilterList represents a list of values for the FacetFilter control.

FacetFilterListDataTypeFacetFilterList data types.

FacetFilterTypeUsed by the FacetFilter control to adapt its design according to type.

FeedContentDisplays a tile containing the text of the feed, a subheader, and a numeric value.

FeedInputThe Feed Input allows the user to enter text for a new feed entry and then post it.

FeedListItemThe control provides a set of properties for text, sender information, time stamp.

FlexAlignContentAvailable options for the layout of container lines along the cross axis of the flexbox layout.

FlexAlignItemsAvailable options for the layout of all elements along the cross axis of the flexbox layout.

FlexAlignSelfAvailable options for the layout of individual elements along the cross axis of the flexbox layout overriding the default alignment.

FlexBoxThe sap.m.FlexBox control builds the container for a flexible box layout.

FlexDirectionAvailable directions for flex layouts.

FlexItemDataHolds layout data for a FlexBox|HBox|VBox

FlexJustifyContentAvailable options for the layout of elements along the main axis of the flexbox layout.

FlexRendertypeDetermines the type of HTML elements used for rendering controls.

FlexWrapAvailable options for the wrapping behavior of a flex container.

FormattedTextThe FormattedText control allows the usage of a limited set of tags for inline display of formatted text in HTML format.

FrameTypeEnum for possible frame size types for sap.m.DynamicContent and sap.m.GenricTile control.

GenericTileDisplays the title, description, and a customizable main area.

GenericTileModeDefines the mode of GenericTile.

GroupHeaderListItemsap.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.

GrowingEnablement

GrowingListsap.m.GrowingList control is the container for all list items and inherits from sap.m.List control.

HBoxThe HBox control builds the container for a horizontal flexible box layout.

HeaderLevelDifferent levels for headers

IBarInterface for controls which are suitable as a Header, Subheader or Footer of a Page.

IBarHTMLTagAllowed tags for the implementation of the IBar interface.

IBarInPageEnablerHelper Class for implementing the IBar interface.

IconTabRepresents an interface for controls, which are suitable as items for the sap.m.IconTabBar.

IconTabBarThe IconTabBar control represents a collection of tabs with associated content.

IconTabFilterRepresents a selectable item inside an IconTabBar.

IconTabFilterDesignAvailable Filter Item Design.

IconTabHeaderThis control displays a number of IconTabFilters and IconTabSeparators.

IconTabSeparatorRepresents an Icon used to separate 2 tab filters.

ImageA wrapper around the IMG tag.

ImageContentThis control can be displayed as image content in a tile.

ImageHelperHelper for Images.

ImageModeDetermines how the source image is used on the output DOM element.

InputEnables users to input data.

InputBaseThe sap.m.InputBase control provides a base functionality of the Input controls, e.g.

InputListItemList item should be used for a label and an input field.

InputODataSuggestProviderSuggestion helper for sap.m.Input fields: Creates a multi column suggest list for a sap.m.Input field based on a ValueList annotation.

InputTypeA subset of input types that fits to a simple API returning one string.

ISnappableInterface for controls which are suitable as a Header in sap.m.DynamicPage.

LabelThe Label control is used in a UI5 mobile application to provide label text for other controls.

LabelDesignAvailable label display modes.

LinkA hyperlink control which can be used to trigger actions or to navigate to other applications or web pages.

ListThe List control provides a container for all types of list items.

ListBaseThe sap.m.ListBase control provides a base functionality of the sap.m.List and sap.m.Table controls.

ListHeaderDesignDefines the different header styles.

ListItemBaseListItemBase contains the base features of all specific list items.

ListKeyboardModeDefines the keyboard handling behavior of the sap.m.List or sap.m.Table.

ListModeDefines the mode of the list.

ListSeparatorsDefines which separator style will be applied for the items.

ListTypeDefines the visual indication and behaviour of the list items.

LoadStateEnumeration of possible load statuses.

MaskInputThe 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).

MaskInputRuleThe sap.m.MaskInputRule control holds the mapping of a single maskFormatSymbol to the regular expression regex that defines the allowed characters for the rule.

MenuThe sap.m.Menu control represents a hierarchical menu.

MenuButtonThe sap.m.MenuButton control enables the user to show a hierarchical menu.

MenuButtonModeDifferent mode for a MenuButton (predefined types)

MenuItemThe MenuItem control is used for creating items for the sap.m.Menu.

MessageBoxProvides easier methods to create sap.m.Dialog with type sap.m.DialogType.Message, such as standard alerts, confirmation dialogs, or arbitrary message dialogs.

MessagePageMessagePage is displayed when there is no data or matching content.

MessagePopoverA MessagePopover is a Popover containing a summarized list with messages.

MessagePopoverItemItems provide information about Error Messages in the page.

MessageStripMessageStrip is a control that enables the embedding of application-related messages in the application.

MessageToastA message toast notification offers simple feedback about an operation in a pop-up.

MultiComboBoxThe 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.

MultiInputMultiInput provides functionality to add / remove / enter tokens

NavContainerThe NavContainer control handles hierarchic navigation between Pages or other fullscreen controls.

NavContainerChildsap.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.

NewsContentThis control displays the news content text and subheader in a tile.

NotificationListBaseThe NotificationListBase is the base class for NotificationListItem and NotificationListGroup.

NotificationListGroupThe NotificationListItemGroup control is used for grouping NotificationListItems of the same type.

NotificationListItemThe NotificationListItem control is suitable for showing notifications to the user.

NumericContentShows numeric values used for example in tiles colored according to their meaning and displays deviations.

ObjectAttributeThe ObjectAttribute control displays a text field that can be normal or active.

ObjectHeaderObjectHeader is a display control that enables the user to easily identify a specific object.

ObjectHeaderContainerMarker interface for controls which are suitable as items for the ObjectHeader.

ObjectIdentifierThe ObjectIdentifier is a display control that enables the user to easily identify a specific object.

ObjectListItemObjectListItem is a display control that provides summary information about an object as a list item.

ObjectMarkerThe sap.m.ObjectMarker control represents one of the following predefined types:

Flagged
Favorite
Draft
Locked
Unsaved Changes

ObjectMarkerTypePredefined types for ObjectMarker.

ObjectMarkerVisibilityPredefined visibility for ObjectMarker.

ObjectNumberThe ObjectNumber control displays number and number unit properties for an object.

ObjectStatusStatus information that can be either text with a value state, or an icon.

OverflowToolbarThe OverflowToolbar control is a container based on sap.m.Toolbar, that provides overflow when its content does not fit in the visible area.

OverflowToolbarLayoutDataHolds layout data for the OverflowToolbar items.

OverflowToolbarPriorityDefines the priorities of the controls within sap.m.OverflowToolbar

P13nColumnsItemType for columnsItems aggregation in P13nColumnsPanel control.

P13nColumnsPanelThe P13nColumnsPanel control is used to define column-specific settings for table personalization.

P13nConditionPanelThe ConditionPanel Control will be used to implement the Sorting, Filtering and Grouping panel of the new Personalization dialog.

P13nDialogThe P13nDialog control provides a dialog that contains one or more panels.

P13nDimMeasureItemType for columnsItems aggregation in P13nDimMeasurePanel control.

P13nDimMeasurePanelThe 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.

P13nFilterItemType for filterItems aggregation in P13nFilterPanel control.

P13nFilterPanelThe P13nFilterPanel control is used to define filter-specific settings for table personalization.

P13nGroupItemType for groupItems aggregation in P13nGroupPanel control.

P13nGroupPanelThe P13nGroupPanel control is used to define group-specific settings for table personalization.

P13nItemBase type for items aggregation in P13nPanel control.

P13nPanelBase type for panels aggregation in P13nDialog control.

P13nPanelTypeType of panels used in the personalization dialog.

P13nSortItemType for sortItems aggregation in P13nSortPanel control.

P13nSortPanelThe P13nSortPanel control is used to define settings for sorting in table personalization.

PageA page is a basic container for a mobile application screen.

PageAccessibleLandmarkInfoSettings for accessible landmarks which can be applied to the container elements of a sap.m.Page control.

PageBackgroundDesignAvailable Page Background Design.

PagingButtonEnables users to navigate between items/entities.

PanelThe Panel control is a container for controls which has a header and content.

PlacementTypeTypes for the placement of popover control.

PlanningCalendarThe PlanningCalendar can display rows with appointments for different persons.

PlanningCalendarRowRow in the PlanningCalendar.

PlanningCalendarViewView of the PlanningCalendar.

PopinDisplayDefines the display of table pop-ins

PopoverPopover is used to present information temporarily but in a way that does not take over the entire screen.

PopupHelperHelper for Popups.

ProgressIndicatorShows the progress of a process in a graphical way.

PullToRefreshPullToRefresh control.

QuickViewThe QuickView control renders a responsive popover (sap.m.Popover or sap.m.Dialog) and displays information of an object in a business-card format.

QuickViewBaseQuickViewBase class provides base functionality for QuickView and QuickViewCard.

QuickViewCardThe QuickViewCard control displays information of an object in a business-card format.

QuickViewGroupQuickViewGroup consists of a title (optional) and an entity of group elements.

QuickViewGroupElementQuickViewGroupElement is a combination of one label and another control (Link or Text) associated to this label.

QuickViewGroupElementTypeQuickViewGroupElement is a combination of one label and another control (Link or Text) associated to this label

QuickViewPageQuickViewPage consists of a page header, an object icon or image, an object name with short description, and an object information divided in groups.

RadioButtonRadioButton is a control similar to CheckBox, but it allows the user to choose only one of the predefined set of options.

RadioButtonGroupThis control is used as a wrapper for a group of sap.m.RadioButton controls, which then can be used as a single UI element.

RangeSliderA range slider is a user interface control that enables the user to select a value range in a predifined numerical interval.

RatingIndicatorIs used to rate content.

RatingIndicatorVisualModePossible values for the visualization of float values in the RatingIndicator Control.

ResponsivePopoverThis control acts responsively to the type of device.

routing

ScreenSizeBreakpoint names for different screen sizes.

ScrollContainerThe ScrollContainer is a control that can display arbitrary content within a limited screen area and provides touch scrolling to make all content accessible.

SearchFieldEnables users to input a search string.

SegmentedButtonSegmentedButton is a horizontal control made of multiple buttons, which can display a title or an image.

SegmentedButtonItemThe SegmentedButtonItem control is used for creating buttons for the sap.m.SegmentedButton.

SelectThe sap.m.Select control provides a list of items that allows users to select an item.

SelectDialogA SelectDialog is a dialog containing a list, search functionality to filter it and a confirmation/cancel button.

SelectListThe sap.m.SelectList displays a list of items that allows the user to select an item.

SelectListKeyboardNavigationModeDefines the keyboard navigation mode.

SelectTypeEnumeration for different Select types.

semantic

ShellThe Shell control can be used as root element of applications.

SizeEnumeration of possible size settings.

SliderA slider is a user interface control that enables the user to adjust values in a specified numerical range.

SlideTileThe control that displays multiple GenericTile controls as changing slides.

SplitAppSplitApp is another root element of a UI5 mobile application besides App control.

SplitAppModeThe mode of SplitContainer or SplitApp control to show/hide the master area.

SplitContainerSplitContainer maintains two NavContainers if running on tablet or desktop and one NavContainer - on phone.

StandardListItemsap.m.StandardListItem is a list item providing the most common use cases, e.g.

StandardTileThe StandardTile control is displayed in the tile container.

StandardTileTypeTypes for StandardTile

SuggestionItemDisplay suggestion list items.

SwipeDirectionDirections for swipe event.

SwitchA switch is a user interface control on mobile devices that is used for change between binary states.

SwitchTypeEnumaration for different switch types.

TabContainerThe TabContainer control represents a collection of tabs with associated content.

TabContainerItemAn item to be used in a TabContainer.

Tablesap.m.Table control provides a set of sophisticated and convenience functions for responsive table design.

TablePersoControllerTable Personalization Controller

TablePersoDialogTable Personalization Dialog

TablePersoProviderTable Personalization Provider

TableSelectDialogTableSelectDialog provides you with an easier way to create a dialog that contains a list with grouping and search functionalities.

TabStripSelectListThe sap.m.TabStripSelectList displays a list of items that allows the user to select an item.

TextThe Text control can be used for embedding longer text paragraphs, that need text wrapping, into your application.

TextAreaThe sap.m.TextArea enables multi-line text input.

ThreeColumnLayoutTypeTypes of three-column layout for the sap.m.FlexibleColumnLayout control

TileA tile to be displayed in the tile container.

TileContainerA container that arranges same-size tiles nicely on carousel pages.

TileContentThis control is used within the GenericTile control.

TimePickerThe TimePicker is an extension of the Input control and allows time selection in any device or browser supported by UI5.

TitleThe Title control represents a single line of text with explicit header / title semantics.

ToggleButtonThe ToggleButton Control is a Button that can be toggled between pressed and normal state

TokenThe sap.m.Token is a container of a single text item with a delete icon if the token is in edit mode.

TokenizerTokenizer displays multiple tokens

ToolbarThe Toolbar control is a horizontal container that is most commonly used to display buttons, labels, selects and various other input controls.

ToolbarDesignTypes of the Toolbar Design.

ToolbarLayoutDataDefines layout data for the toolbar items.

ToolbarSeparatorCreates a visual separator (theme dependent: padding, margin, line) between the preceding and succeeding toolbar item.

ToolbarSpacerThis control can be used to add horizontal space between toolbar items.

touchTouch helper.

UploadCollectionThis control allows you to upload single or multiple files from your devices (desktop, tablet or phone) and attach them to the application.

UploadCollectionItemItems provide information about the uploaded files.

UploadCollectionParameterRepresents a parameter for the UploadCollection.

UploadCollectionToolbarPlaceholderThis control needs to be used when you would like to create a customizable toolbar for the UploadCollection.

URLHelperURL(Uniform Resource Locator) Helper.

ValueColorEnumeration of possible value color settings.

ValueCSSColorA string type that represents CSS color values and sap.m.ValueColor.

VBoxThe VBox control builds the container for a vertical flexible box layout.

VerticalPlacementTypeTypes for the placement of message popover control.

ViewSettingsCustomItemThe ViewSettingsCustomItem control is used for modelling custom filters in the ViewSettingsDialog.

ViewSettingsCustomTabThe ViewSettingsCustomTab control is used for adding custom tabs in the ViewSettingsDialog.

ViewSettingsDialogThe ViewSettingsDialog control provides functionality to easily select the options for sorting, grouping, and filtering data.

ViewSettingsFilterItemA ViewSettingsFilterItem control is used for modelling filter behaviour in the ViewSettingsDialog.

ViewSettingsItemViewSettingsItem is used for modelling filter behaviour in the ViewSettingsDialog.

WizardThe Wizard control enables users to accomplish a single goal which consists of multiple dependable sub-tasks.

WizardStepThe WizardStep is a container control which should be used mainly to aggregate user input controls.

Field Summary

sap.m.Support

 sap.m.Support shows the technical information for SAPUI5 Mobile Applications.

closeKeyboard Hide the soft keyboard.

getIScroll Search given control's parents and try to find iScroll.

getScrollDelegate Search given control's parents and try to find ScrollDelegate.

Method Summary

getLocale() Finds default locale settings once and returns always the same.

getLocaleData() Finds default locale data once and returns always the same.

isDate(value) Checks if the given parameter is a valid JsDate Object.

getInvalidDate() Returns invalid date value of UI5.

Field Detail

sap.m.Support

sap.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

As sap.m.Support is a static class, a jQuery.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();

Since:: 1.11.0

closeKeyboard

Hide the soft keyboard.

Since:: 1.20

getIScroll

Search given control's parents and try to find iScroll.

Since:: 1.11

getScrollDelegate

Search given control's parents and try to find ScrollDelegate.

Since:: 1.11

Method Detail

getLocale() : Object

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

Since:: 1.10

Returns:

{Object}

sap.ui.core.Locale instane

getLocaleData() : Object

Finds default locale data once and returns always the same.

Since:: 1.10

Returns:

{Object}

sap.ui.core.LocaleData instance

isDate(value) : boolean

Checks if the given parameter is a valid JsDate Object.

Parameters:

{any}

value

Any variable to test.

Since:: 1.10

Returns:

{boolean}

getInvalidDate() : null

Returns invalid date value of UI5.

Deprecated:
Since 1.12 UI5 returns null for invalid date

Since:: 1.10

Returns:

{null}