Class sap.ui.core.RenderManagerModule: sap/ui/core/RenderManager

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 writeClasses

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 writeStyle

Cleans up the rendering state of the given control with rendering it.

A control is responsible for the rendering of all its child controls. But in some cases it makes sense that a control does not render all its children based on a filter condition. For example a Carousel control only renders the current visible parts (and maybe some parts before and after the visible area) for performance reasons. If a child was rendered but should not be rendered anymore because the filter condition does not apply anymore this child must be cleaned up correctly (e.g deregistering eventhandlers, ...).

The following example shows how renderControl and cleanupControlWithoutRendering should be used:

render = function(rm, ctrl){ //... var aAggregatedControls = //... for(var i=0; i

Note: The method does not remove DOM of the given control. The callee of this method has to take over the responsibility to cleanup the DOM of the control afterwards. For parents which are rendered with the normal mechanism as shown in the example above this requirement is fulfilled, because the control is not added to the rendering buffer (renderControl is not called) and the DOM is replaced when the rendering cycle is finalized.

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.

Renders the content of the rendering buffer into the provided DOMNode.

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

Returns the configuration object Shortcut for sap.ui.getCore().getConfiguration()

Returns the renderer class for a given control instance

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.

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.

Write the given texts to the buffer

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 which referencing 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 fullfills 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 precense or absence of the visibility property. {hidden : null} ensures that no aria-hidden attribute is written independent of the precense 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).

Writes the attribute and its value into the HTML

Writes the attribute and its value into the HTML

The value is properly escaped to avoid XSS attacks.

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.

Writes the controls data into the HTML. Control Data consists at least of the id of a control

Writes the elements data into the HTML. Element Data consists at least of the id of a element

Escape text for HTML and write it to the buffer

Writes and flushes the style collection