namespace sap.ui.core

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

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.


Nodes Overview

Node Description
sap/ui/core/ComponentSupport

The module sap/ui/core/ComponentSupport provides functionality which is used to find declared Components in the HTML page and to create the Component instances which will be put into a sap.ui.core.ComponentContainer.

sap/ui/core/InvisibleRenderer

Provides the default renderer for the controls that have set their visible property to false.

sap/ui/core/syncStyleClass

Search ancestors of the given source DOM element for the specified CSS class name.

sap.ui.core.AbsoluteCSSSize

A string type that represents non-relative CSS size values.

sap.ui.core.AccessibleLandmarkRole

Defines the accessible landmark roles for ARIA support.

sap.ui.core.AccessibleRole

Defines the accessible roles for ARIA support.

sap.ui.core.AppCacheBuster

The AppCacheBuster is used to hook into URL relevant functions in jQuery and SAPUI5 and rewrite the URLs with a timestamp segment.

sap.ui.core.BarColor

Configuration options for the colors of a progress bar.

sap.ui.core.BusyIndicator

Provides methods to show or hide a waiting animation covering the whole page and blocking user interaction.

sap.ui.core.BusyIndicatorSize

Configuration options for the BusyIndicator size.

sap.ui.core.BusyIndicatorUtils
sap.ui.core.CalendarType

The types of Calendar.

sap.ui.core.Collision

Collision behavior: horizontal/vertical.

sap.ui.core.CommandExecution
sap.ui.core.Component

Base Class for Components.

sap.ui.core.ComponentContainer

Container that embeds a sap/ui/core/UIComponent in a control tree.

sap.ui.core.ComponentLifecycle

Enumeration for different lifecycle behaviors of components created by the ComponentContainer.

sap.ui.core.ComponentMetadata
sap.ui.core.Configuration

Collects and stores the configuration of the current environment.

sap.ui.core.Control

Base Class for Controls.

sap.ui.core.Core

Core Class of the SAP UI Library.

sap.ui.core.CSSColor

A string type that represents CSS color values.

sap.ui.core.CSSSize

A string type that represents CSS size values.

sap.ui.core.CSSSizeShortHand

This type checks the short hand form of a margin or padding definition.

sap.ui.core.CustomData

Contains a single key/value pair of custom data attached to an Element.

sap.ui.core.DeclarativeSupport

Static class for enabling declarative UI support.

sap.ui.core.delegate
sap.ui.core.Design

Font design for texts.

sap.ui.core.dnd

Contains classes and helpers related to drag & drop functionality.

sap.ui.core.Dock

Docking position: horizontal/vertical.

sap.ui.core.Element

Base Class for UI Elements.

sap.ui.core.ElementMetadata
sap.ui.core.EnabledPropagator
sap.ui.core.EventBus

Provides eventing capabilities for applications like firing events and attaching or detaching event handlers for events which are notified when events are fired.

sap.ui.core.ExtensionPoint
sap.ui.core.format

Format classes

sap.ui.core.Fragment

Fragments support the definition of light-weight stand-alone UI control trees.

sap.ui.core.History

History handles the history of certain controls (e.g.

sap.ui.core.HorizontalAlign

Configuration options for horizontal alignments of controls.

sap.ui.core.HTML

Embeds standard HTML in an SAPUI5 control tree.

sap.ui.core.IAsyncContentCreation

Marker interface for subclasses of sap.ui.core.UIComponent.

sap.ui.core.Icon

Icon uses embedded font instead of pixel image.

sap.ui.core.IconColor

Semantic Colors of an icon.

sap.ui.core.IconPool

The IconPool is a static class for retrieving or registering icons.

sap.ui.core.IContextMenu

Marker interface for controls that can serve as a context menu.

sap.ui.core.ID

A string type representing an ID or a name.

sap.ui.core.IDScope

Marker interface to flag controls that provide access to substructures from a byId method.

sap.ui.core.IFormContent

Marker interface for controls that can be used as content of sap.ui.layout.form.Form or sap.ui.layout.form.SimpleForm.

sap.ui.core.ImeMode

State of the Input Method Editor (IME) for the control.

sap.ui.core.IndicationColor

Colors to highlight certain UI elements.

sap.ui.core.IndicationColorSupport

Helper functionality for indication color support.

sap.ui.core.IntervalTrigger

Provides a trigger that triggers in a set interval and calls all registered listeners.

sap.ui.core.InvisibleMessage

The InvisibleMessage provides a way to programmatically expose dynamic content changes in a way that can be announced by screen readers.

sap.ui.core.InvisibleMessageMode

Enumeration for different mode behaviors of the InvisibleMessage.

sap.ui.core.InvisibleText

An InvisibleText is used to bring hidden texts to the UI for screen reader support.

sap.ui.core.IPlaceholderSupport

Marker interface for container controls.

sap.ui.core.ISemanticFormContent

Marker interface for controls that can be used as content of sap.ui.layout.form.SemanticFormElement.

sap.ui.core.IShrinkable

Interface for the controls which are suitable to shrink.

sap.ui.core.Item

A control base type.

sap.ui.core.ITitleContent

Marker interface for controls that can be used in content aggregation of the sap.m.Title control.

sap.ui.core.Label

Marker interface for controls which are suitable for use as label.

sap.ui.core.LabelEnablement

Helper functionality for enhancement of a Label with common label functionality.

sap.ui.core.LayoutData

A layout data base type.

sap.ui.core.ListItem

An item that is used in list controls, such as DropdownBox.

sap.ui.core.LocalBusyIndicator

The LocalBusyIndicator is a special version of the BusyIndicator.

sap.ui.core.Locale

Locale represents a locale setting, consisting of a language, script, region, variants, extensions and private use section.

sap.ui.core.LocaleData

Provides access to locale-specific data, such as, date formats, number formats, and currencies.

sap.ui.core.Manifest

The Manifest class.

sap.ui.core.Message

This element is used to provide messages.

sap.ui.core.message
sap.ui.core.MessageType

Defines the different message types.

sap.ui.core.mvc
sap.ui.core.OpenState

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.

sap.ui.core.Orientation

Orientation of a UI element.

sap.ui.core.Patcher

Creates a Patcher instance which can be used for in-place DOM patching.

sap.ui.core.Percentage

A string type that represents a percentage value.

sap.ui.core.Popup

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 menus, dialogs, drop down boxes.

sap.ui.core.PopupInterface

Marker interface for controls that are not rendered "embedded" into other controls but need to be opened/closed.

sap.ui.core.Priority

Priorities for general use.

sap.ui.core.Renderer

Base Class for a Renderer.

sap.ui.core.RenderManager

A class that handles the rendering of controls.

sap.ui.core.ResizeHandler

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.

sap.ui.core.ScrollBar

The ScrollBar control can be used for virtual scrolling of a certain area.

sap.ui.core.ScrollBarAction

Actions are: Click on track, button, drag of thumb, or mouse wheel click.

sap.ui.core.Scrolling

Defines the possible values for horizontal and vertical scrolling behavior.

sap.ui.core.SeparatorItem

An item that provides a visual separation.

sap.ui.core.SortOrder

Sort order of a column.

sap.ui.core.TextAlign

Configuration options for text alignments.

sap.ui.core.TextDirection

Configuration options for the direction of texts.

sap.ui.core.theming
sap.ui.core.Title

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

sap.ui.core.TitleLevel

Level of a title.

sap.ui.core.Toolbar

Marker interface for toolbar controls.

sap.ui.core.TooltipBase

Abstract class that can be extended in order to implement any extended tooltip.

sap.ui.core.UIArea

An area in a page that hosts a tree of UI elements.

sap.ui.core.UIComponent

Base Class for UIComponent.

sap.ui.core.URI

A string type that represents an RFC 3986 conformant URI.

sap.ui.core.ValueState

Marker for the correctness of the current value.

sap.ui.core.ValueStateSupport

Helper functionality for value state support.

sap.ui.core.VariantLayoutData

Allows to add multiple LayoutData to one control in case that an easy switch of layouts (e.g.

sap.ui.core.VerticalAlign

Configuration options for vertical alignments, for example of a layout cell content within the borders.

sap.ui.core.Wrapping

Configuration options for text wrapping.

sap.ui.core.XMLComposite

Base Class for XMLComposite controls.

sap.ui.core.date
sap.ui.core.support
sap.ui.core.aria
sap.ui.core.hyphenation
sap.ui.core.postmessage
sap.ui.core.routing
sap.ui.core.search
sap.ui.core.service
sap.ui.core.tmpl
sap.ui.core.util
sap.ui.core.ws

Methods Overview

Method Description
sap.ui.core.CustomStyleClassSupport

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); (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:

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.

sap.ui.core.CustomStyleClassSupport

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); (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:

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.

Param Type DefaultValue Description