Class sap.ui.unified.ContentSwitcherModule: sap/ui/unified/ContentSwitcher

extends Control

Switches between two control areas and animates it via CSS transitions

Experimental API:Since version 1.16.0. API is not yet finished and might change completely


Since: 1.16.0.
Constructor Summary
new sap.ui.unified.ContentSwitcher(sId?, mSettings?)Constructor for a new ContentSwitcher.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.unified.ContentSwitcher.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.unified.ContentSwitcher with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.unified.ContentSwitcher.getMetadata()Returns a metadata object for class sap.ui.unified.ContentSwitcher.
addContent1(oContent1)Adds some content1 to the aggregation content1.
addContent2(oContent2)Adds some content2 to the aggregation content2.
destroyContent1()Destroys all the content1 in the aggregation content1.
destroyContent2()Destroys all the content2 in the aggregation content2.
getActiveContent()Gets current value of property activeContent.
getAnimation()Gets current value of property animation.
getContent1()Gets content of aggregation content1.
getContent2()Gets content of aggregation content2.
indexOfContent1(oContent1)Checks for the provided sap.ui.core.Control in the aggregation content1.
indexOfContent2(oContent2)Checks for the provided sap.ui.core.Control in the aggregation content2.
insertContent1(oContent1, iIndex)Inserts a content1 into the aggregation content1.
insertContent2(oContent2, iIndex)Inserts a content2 into the aggregation content2.
removeAllContent1()Removes all the controls from the aggregation content1.
removeAllContent2()Removes all the controls from the aggregation content2.
removeContent1(vContent1)Removes a content1 from the aggregation content1.
removeContent2(vContent2)Removes a content2 from the aggregation content2.
setActiveContent(iActiveContent)Sets a new value for property activeContent.
setAnimation(sAnimation)Sets a new value for property animation.
switchContent()Changes the currently active content to the other one.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.unified.ContentSwitcher(sId?, mSettings?)
Constructor for a new ContentSwitcher.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.unified.ContentSwitcher.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.unified.ContentSwitcher with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.unified.ContentSwitcher.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.unified.ContentSwitcher.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent1(oContent1): sap.ui.unified.ContentSwitcher
Adds some content1 to the aggregation content1.
Parameters:
{sap.ui.core.Control}oContent1 the content1 to add; if empty, nothing is inserted
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
addContent2(oContent2): sap.ui.unified.ContentSwitcher
Adds some content2 to the aggregation content2.
Parameters:
{sap.ui.core.Control}oContent2 the content2 to add; if empty, nothing is inserted
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
destroyContent1(): sap.ui.unified.ContentSwitcher
Destroys all the content1 in the aggregation content1.
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
destroyContent2(): sap.ui.unified.ContentSwitcher
Destroys all the content2 in the aggregation content2.
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
getActiveContent(): int
Gets current value of property activeContent.

The number of the currently active content (1 or 2).

Default value is 1.

Returns:
{int} Value of property activeContent
getAnimation(): string
Gets current value of property animation.

Set the used animation when changing content. This just sets a CSS-class named "sapUiUnifiedACSwitcherAnimation" + this value on the root element of the control. The animation has to be implemented in CSS. This also enables applications to implement their own animations via CSS by reacting to the parent class. See the types sap.ui.unified.ContentSwitcherAnimation for default implementations.

Default value is None.

Returns:
{string} Value of property animation
getContent1(): sap.ui.core.Control[]
Gets content of aggregation content1.

The controls that should be shown in the first content

Returns:
{sap.ui.core.Control[]}
getContent2(): sap.ui.core.Control[]
Gets content of aggregation content2.

The controls that should be shown in the second content

Returns:
{sap.ui.core.Control[]}
indexOfContent1(oContent1): int
Checks for the provided sap.ui.core.Control in the aggregation content1. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent1 The content1 whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfContent2(oContent2): int
Checks for the provided sap.ui.core.Control in the aggregation content2. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent2 The content2 whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent1(oContent1, iIndex): sap.ui.unified.ContentSwitcher
Inserts a content1 into the aggregation content1.
Parameters:
{sap.ui.core.Control}oContent1 the content1 to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the content1 should be inserted at; for a negative value of iIndex, the content1 is inserted at position 0; for a value greater than the current size of the aggregation, the content1 is inserted at the last position
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
insertContent2(oContent2, iIndex): sap.ui.unified.ContentSwitcher
Inserts a content2 into the aggregation content2.
Parameters:
{sap.ui.core.Control}oContent2 the content2 to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the content2 should be inserted at; for a negative value of iIndex, the content2 is inserted at position 0; for a value greater than the current size of the aggregation, the content2 is inserted at the last position
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
removeAllContent1(): sap.ui.core.Control[]
Removes all the controls from the aggregation content1.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllContent2(): sap.ui.core.Control[]
Removes all the controls from the aggregation content2.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent1(vContent1): sap.ui.core.Control
Removes a content1 from the aggregation content1.
Parameters:
{int|string|sap.ui.core.Control}vContent1 The content1to remove or its index or id
Returns:
{sap.ui.core.Control} The removed content1 or null
removeContent2(vContent2): sap.ui.core.Control
Removes a content2 from the aggregation content2.
Parameters:
{int|string|sap.ui.core.Control}vContent2 The content2to remove or its index or id
Returns:
{sap.ui.core.Control} The removed content2 or null
setActiveContent(iActiveContent): sap.ui.unified.ContentSwitcher
Sets a new value for property activeContent.

The number of the currently active content (1 or 2).

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

Default value is 1.

Parameters:
{int}iActiveContent New value for property activeContent
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
setAnimation(sAnimation): sap.ui.unified.ContentSwitcher
Sets a new value for property animation.

Set the used animation when changing content. This just sets a CSS-class named "sapUiUnifiedACSwitcherAnimation" + this value on the root element of the control. The animation has to be implemented in CSS. This also enables applications to implement their own animations via CSS by reacting to the parent class. See the types sap.ui.unified.ContentSwitcherAnimation for default implementations.

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

Default value is None.

Parameters:
{string}sAnimation New value for property animation
Returns:
{sap.ui.unified.ContentSwitcher} Reference to this in order to allow method chaining
switchContent()
Changes the currently active content to the other one. If content 1 is active, content 2 will be activated and the other way around.