Class sap.ui.vk.ContainerBaseModule: sap/ui/vk/ContainerBase
extends Control
known direct subclasses: MapContainer
Abstract Constructor for a new Container.
Experimental API:Since 1.38.0 This class is experimental and might be modified or removed in future versions.
Constructor Summary
Event Summary
contentChange(oControlEvent)
settingsPressed(oControlEvent)
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ui.vk.ContainerBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.ContainerBase with name
sClassName and enriches it with the information contained in oClassInfo.attachContentChange(oData?, fnFunction, oListener?)Attaches event handler
fnFunction to the contentChange event of this sap.ui.vk.ContainerBase.attachSettingsPressed(oData?, fnFunction, oListener?)Attaches event handler
fnFunction to the settingsPressed event of this sap.ui.vk.ContainerBase.detachContentChange(fnFunction, oListener)Detaches event handler
fnFunction from the contentChange event of this sap.ui.vk.ContainerBase.detachSettingsPressed(fnFunction, oListener)Detaches event handler
fnFunction from the settingsPressed event of this sap.ui.vk.ContainerBase.indexOfContent(oContent)Checks for the provided
sap.ui.vk.ContainerContent in the aggregation content.setFullScreen(bFullScreen)set FullScreen - default is normal mode, but app can call this method to set the default to full screen
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, init, 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
Constructor Detail
new sap.ui.vk.ContainerBase(sId?, mSettings?)
Abstract Constructor for a new Container.
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:
- Properties
- showFullScreen : boolean (default: true)
- showSettings : boolean (default: true)
- showSelection : boolean (default: true)
- fullScreen : boolean (default: false)
- title : string (default: )
- autoAdjustHeight : boolean (default: false)
- Aggregations
- content : sap.ui.vk.ContainerContent[] (default)
- Events
- contentChange : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- settingsPressed : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
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 |
Event Detail
contentChange(oControlEvent)
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
settingsPressed(oControlEvent)
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
Method Detail
sap.ui.vk.ContainerBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.ContainerBase 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.vk.ContainerBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.ContainerBase.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
addContent(oObject): void
add container content - map, table..
Parameters:
| {sap.ui.vk.ContainerContent} | oObject | content object to add |
attachContentChange(oData?, fnFunction, oListener?): sap.ui.vk.ContainerBase
Attaches event handler
fnFunction to the contentChange event of this sap.ui.vk.ContainerBase. 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.vk.ContainerBase itself.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vk.ContainerBase itself |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
attachSettingsPressed(oData?, fnFunction, oListener?): sap.ui.vk.ContainerBase
Attaches event handler
fnFunction to the settingsPressed event of this sap.ui.vk.ContainerBase. 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.vk.ContainerBase itself.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.vk.ContainerBase itself |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
destroyContent(): sap.ui.vk.ContainerBase
Destroys all the content in the aggregation
content. Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
detachContentChange(fnFunction, oListener): sap.ui.vk.ContainerBase
Detaches event handler
fnFunction from the contentChange event of this sap.ui.vk.ContainerBase. The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
detachSettingsPressed(fnFunction, oListener): sap.ui.vk.ContainerBase
Detaches event handler
fnFunction from the settingsPressed event of this sap.ui.vk.ContainerBase. The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
fireContentChange(mArguments?): sap.ui.vk.ContainerBase
Fires event
contentChange to attached listeners. Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
fireSettingsPressed(mArguments?): sap.ui.vk.ContainerBase
Fires event
settingsPressed to attached listeners. Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
getAutoAdjustHeight(): boolean
Gets current value of property
autoAdjustHeight. Default value is false.
Returns:
| {boolean} | Value of property autoAdjustHeight |
getContent(): sap.ui.vk.ContainerContent[]
Gets content of aggregation
content. Content Aggregation.
Returns:
| {sap.ui.vk.ContainerContent[]} |
getFullScreen(): boolean
Gets current value of property
fullScreen. Controls whether the control is show fullscreen or embedded
Default value is false.
Returns:
| {boolean} | Value of property fullScreen |
getSelectedContent(): sap.ui.vk.ContainerContent
get selected content
Returns:
| {sap.ui.vk.ContainerContent} | the currently selected content container |
getShowFullScreen(): boolean
Gets current value of property
showFullScreen. Show fullscreen toggle button in toolbar
Default value is true.
Returns:
| {boolean} | Value of property showFullScreen |
getShowSelection(): boolean
Gets current value of property
showSelection. Show selection button in toolbar
Default value is true.
Returns:
| {boolean} | Value of property showSelection |
getShowSettings(): boolean
Gets current value of property
showSettings. Show settings button in toolbar
Default value is true.
Returns:
| {boolean} | Value of property showSettings |
getTitle(): string
Gets current value of property
title. Title to show in toolbar
Default value is .
Returns:
| {string} | Value of property title |
indexOfContent(oContent): int
Checks for the provided
sap.ui.vk.ContainerContent in the aggregation content. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.vk.ContainerContent} | oContent | The content whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
insertContent(oObject, iIndex): void
insert container content - map, table..
Parameters:
| {sap.ui.vk.ContainerContent} | oObject | content object to insert |
| {int} | iIndex | index in the content aggregation where to insert the new content object |
removeAllContent(): sap.ui.vk.ContainerContent[]
Removes all the controls from the aggregation
content. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.vk.ContainerContent[]} | An array of the removed elements (might be empty) |
removeContent(vContent): sap.ui.vk.ContainerContent
Removes a content from the aggregation
content. Parameters:
| {int|string|sap.ui.vk.ContainerContent} | vContent | The contentto remove or its index or id |
Returns:
| {sap.ui.vk.ContainerContent} | The removed content or null |
setAutoAdjustHeight(bAutoAdjustHeight): sap.ui.vk.ContainerBase
Sets a new value for property
autoAdjustHeight. When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bAutoAdjustHeight | New value for property autoAdjustHeight |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
setFullScreen(bFullScreen): void
set FullScreen - default is normal mode, but app can call this method to set the default to full screen
Parameters:
| {boolean} | bFullScreen | Fullscreen mode on or off |
setSelectedContent(oContent): void
set selected content
Parameters:
| {sap.ui.vk.ContainerContent} | oContent | the selected content; involves no re-rendering |
setShowFullScreen(bShowFullScreen): sap.ui.vk.ContainerBase
Sets a new value for property
showFullScreen. Show fullscreen toggle button in toolbar
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bShowFullScreen | New value for property showFullScreen |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
setShowSelection(bShowSelection): sap.ui.vk.ContainerBase
Sets a new value for property
showSelection. Show selection button in toolbar
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bShowSelection | New value for property showSelection |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
setShowSettings(bShowSettings): sap.ui.vk.ContainerBase
Sets a new value for property
showSettings. Show settings button in toolbar
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bShowSettings | New value for property showSettings |
Returns:
| {sap.ui.vk.ContainerBase} | Reference to this in order to allow method chaining |
switchContent(oContent): void
default Content could be defined in application
Parameters:
| {sap.ui.vk.ContainerContent} | oContent | the content to be visible; involves re-rendering |