namespace sap.ui.commons

Control sample: sap.ui.commons
Visiblity: public
Available since: N/A
Module: sap/ui/commons/library
Application Component: CA-UI5-CTR

Common basic controls, mainly intended for desktop scenarios


Nodes Overview

Node Description
sap.ui.commons.Accordion

Contains N sections, acting as containers for any library control

sap.ui.commons.AccordionSection

Represents a panel which is a container for other controls.

sap.ui.commons.ApplicationHeader

The application header control stands on the top of any application page.

sap.ui.commons.Area

Used for defining areas in an image map.

sap.ui.commons.AutoComplete

Textfield with list based text completion.

sap.ui.commons.Button

Enables users to trigger actions such as save or print.

sap.ui.commons.ButtonStyle

different styles for a button.

sap.ui.commons.Callout

Callout is a small popup with some useful information and links that is shown when a mouse is hovered over a specific view element.

sap.ui.commons.CalloutBase

CalloutBase is a building block for Callout.

sap.ui.commons.Carousel

Carousel holds multiple controls and displays them vertically or horizontally next to each other.

sap.ui.commons.CheckBox

Provides a box which can be flagged, the box has a label.

sap.ui.commons.ColorPicker

This control gives the user the opportunity to choose a color.

sap.ui.commons.ColorPickerMode

Different styles for a ColorPicker.

sap.ui.commons.ComboBox

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.

sap.ui.commons.DatePicker

Allows end users to interact with dates.

sap.ui.commons.Dialog

An interactive window appearing on request displaying information to the user.

sap.ui.commons.DropdownBox

The control provides a field that allows end users to an entry out of a list of pre-defined items.

sap.ui.commons.enums
sap.ui.commons.FileUploader

The framework generates an input field and a button with text "Browse ...".

sap.ui.commons.FileUploaderParameter

Represents a parameter for the FileUploader which is rendered as a hidden inputfield.

sap.ui.commons.form
sap.ui.commons.FormattedTextView

The FormattedTextView control allows the usage of a limited set of HTML tags for display.

sap.ui.commons.FormattedTextViewControl

Marker interface for common controls which are suitable for use within a FormattedTextView.

sap.ui.commons.HorizontalDivider

Divides the screen in visual areas.

sap.ui.commons.HorizontalDividerHeight

Enumeration of possible HorizontalDivider height settings.

sap.ui.commons.HorizontalDividerType

Enumeration of possible HorizontalDivider types.

sap.ui.commons.Image

A wrapper around the IMG tag.

sap.ui.commons.ImageMap

Combination of image areas where at runtime these areas are starting points for hyperlinks or actions

sap.ui.commons.InPlaceEdit

The InPlaceEdit is a functionality to have text in display mode that can be changed in place.

sap.ui.commons.Label

The control is used for labeling other controls.

sap.ui.commons.LabelDesign

Available label display modes.

sap.ui.commons.layout
sap.ui.commons.Link

Provides an absolute or relative reference to an internal or external URL.

sap.ui.commons.ListBox

Provides a list of items from which users can choose an item.

sap.ui.commons.Menu

A menu is an interactive element which provides a choice of different actions to the user.

sap.ui.commons.MenuBar

Represents a user interface area which is the entry point for menus with their menu items.

sap.ui.commons.MenuBarDesign

Determines the visual design of a MenuBar.

sap.ui.commons.MenuButton

Common button control that opens a menu when clicked by the user.

sap.ui.commons.MenuItem

Standard item to be used inside a menu.

sap.ui.commons.MenuItemBase

Abstract base class for menu item which provides common properties and events for all concrete item implementations.

sap.ui.commons.MenuTextFieldItem

Special menu item which contains a label and a text field.

sap.ui.commons.Message

Creates the "Message"s to be supplied to the "MessageBar" Control.

sap.ui.commons.MessageBar

Creates an instance of a MessageBar Control, for displaying messages.

sap.ui.commons.MessageBox

Provides methods to create standard alerts, confirmation dialogs, or arbitrary message boxes.

sap.ui.commons.MessageList

Instantiated by the "MessageBar" Control if the user requests to generate the corresponding "MessageList".

sap.ui.commons.MessageToast

Responsible for displaying the new incoming messages, one at the time, on top of the MessageBar.

sap.ui.commons.MessageType

[Enter description for MessageType]

sap.ui.commons.Paginator

Provides navigation between pages within a list of numbered pages.

sap.ui.commons.PaginatorEvent

Distinct paginator event types

sap.ui.commons.Panel

Represents a container with scroll functionality, that can be used for text and controls.

sap.ui.commons.PasswordField

A text field with masked characters which borrows its properties and methods from TextField.

sap.ui.commons.ProgressIndicator

Shows the progress of a process in a graphical way.

sap.ui.commons.RadioButton

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

sap.ui.commons.RadioButtonGroup

The RadioButtonGroup is a basic control that is used to provide area for making interactive choice out of a set of options.

sap.ui.commons.RangeSlider

The interactive control is displayed either as a horizontal or a vertical line with two pointers and units of measurement.

sap.ui.commons.RatingIndicator

RatingIndicator is used to let the user do some rating on a given topic.

sap.ui.commons.RatingIndicatorVisualMode

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

sap.ui.commons.ResponsiveContainer

Is used to provide a container, which can show different content depending on its current width.

sap.ui.commons.ResponsiveContainerRange

Defines a range for the ResponsiveContainer

sap.ui.commons.RichTooltip

Is used to provide tool tips that can have long text, image and title.

sap.ui.commons.RoadMap

RoadMap is used to display step-by-step work flows of a clearly defined work process.

sap.ui.commons.RoadMapStep

Step used within a RoadMap Control.

sap.ui.commons.RowRepeater

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.

sap.ui.commons.RowRepeaterDesign

Determines the visual design of a RowRepeater.

sap.ui.commons.RowRepeaterFilter

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.

sap.ui.commons.RowRepeaterSorter

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.

sap.ui.commons.SearchField

Allows the user to type search queries and to trigger the search.

sap.ui.commons.SearchProvider

A SearchProvider which can be attached to a Search Field.

sap.ui.commons.SegmentedButton

The SegmentedButton provides a group of multiple buttons.

sap.ui.commons.Slider

The interactive control is displayed either as a horizontal or a vertical line with a pointer and units of measurement.

sap.ui.commons.Splitter

Allows to split the screen into two areas.

sap.ui.commons.SplitterSize

A string type that represents subset of CSS size values.

sap.ui.commons.Tab

Represents a single tab in a TabStrip control.

sap.ui.commons.TabStrip

TabStrip represents a container for tab controls, which contain the content and generally other controls.

sap.ui.commons.TextArea

Control to enter or display multible row text.

sap.ui.commons.TextField

Renders an input field for text input.

sap.ui.commons.TextView

Is used to display some continous text.

sap.ui.commons.TextViewColor

Semantic Colors of a text.

sap.ui.commons.TextViewDesign

Designs for TextView.

sap.ui.commons.Title

Represents a title element that can be used for aggregation with other controls

sap.ui.commons.TitleLevel

Level of a title.

sap.ui.commons.ToggleButton

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

sap.ui.commons.Toolbar

A horizontal row of items where in many cases the single toolbar items are buttons containing icons.

sap.ui.commons.ToolbarDesign

Determines the visual design of a Toolbar.

sap.ui.commons.ToolbarItem

Marker interface for common controls which are suitable for use within a toolbar.

sap.ui.commons.ToolbarSeparator

A small vertical line that is generally added to the tool bar between the items to visually separate them.

sap.ui.commons.ToolbarSeparatorDesign

Design of the Toolbar Separator.

sap.ui.commons.Tree

Simple tree to display item in a hierarchical way

sap.ui.commons.TreeNode

Tree node element

sap.ui.commons.TreeSelectionMode

Selection mode of the tree

sap.ui.commons.TriStateCheckBox

TriStateCheckBox to reflect mixed state for checkboxes.

sap.ui.commons.TriStateCheckBoxState

States for TriStateCheckBox

sap.ui.commons.ValueHelpField

A TextField with an attached icon which triggeres an event.


Methods Overview

Method Description