library

Helper for rendering themable background.

Since: 1.12.

Method Summary

addBackgroundColorStyles(rm, sBgColor?, sBgImgUrl?)Adds CSS classes and styles to the given RenderManager, depending on the given configuration for background color and background image.

renderBackgroundImageTag(rm, oControl, vCssClass, sBgImgUrl?, bRepeat?, fOpacity?)Renders an HTML tag into the given RenderManager which carries the background image which is either configured and given or coming from the current theme.

Method Detail

addBackgroundColorStyles(rm, sBgColor?, sBgImgUrl?)

Adds CSS classes and styles to the given RenderManager, depending on the given configuration for background color and background image. To be called by control renderers supporting the global themable background image within their root tag, before they call writeClasses() and writeStyles().

Parameters:

{sap.ui.core.RenderManager}	rm	the RenderManager
{String}	sBgColor?	a configured custom background color for the control, if any
{sap.ui.core.URI}	sBgImgUrl?	the configured custom background image for the control, if any

renderBackgroundImageTag(rm, oControl, vCssClass, sBgImgUrl?, bRepeat?, fOpacity?)

Renders an HTML tag into the given RenderManager which carries the background image which is either configured and given or coming from the current theme. Should be called right after the opening root tag has been completed, so this is the first child element inside the control.

Parameters:

	rm	the RenderManager
{sap.ui.core.Control}	oControl	the control within which the tag will be rendered; its ID will be used to generate the element ID
{String\|String[]}	vCssClass	a css class or an array of css classes to add to the element
{sap.ui.core.URI}	sBgImgUrl?	the image of a configured background image; if this is not given, the theme background will be used and also the other settings are ignored.
{boolean}	bRepeat?	whether the background image should be repeated/tiled (or stretched)
{float}	fOpacity?	the background image opacity, if any