Abstract Class sap.ui.core.ControlModule: sap/ui/core/Control

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.

Note:This only works in IE and Safari; for Firefox the element's style must be set to:

  -moz-user-select: none;

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 Control.addStyleClass() instead if the modification is of visual nature.

Use detachBrowserEvent() to remove the event handler(s) again.

When called, 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.

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.

The passed function and listener object must match the ones used for event registration.

Whether the control is currently in busy state.

Default value is false.

The delay in milliseconds, after which the busy indicator will show up for this control.

Default value is 1000.

By default, this is the Id of the control itself.

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.

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

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.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is [].

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.

See addStyleClass and removeStyleClass for further documentation.