Class sap.landvisz.internal.DataContainerModule: sap/landvisz/internal/DataContainer
A control that renders the data container section in a system
sClassName
and enriches it with the information contained in oClassInfo
.fnFunction
to the 'select' event of this sap.landvisz.internal.DataContainer
.fnFunction
from the 'select' event of this sap.landvisz.internal.DataContainer
.sap.ui.core.Control
in the aggregation named properties
and returns its index if found or -1 otherwise. Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers.
If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).
The supported settings are:
- Properties
- header : string
- selected : boolean (default: true)
- renderingSize : sap.landvisz.EntityCSSSize (default: sap.landvisz.EntityCSSSize.Regular)
- type : sap.landvisz.LandscapeObject
- Aggregations
- properties : sap.ui.core.Control[]
- Associations
- Events
- select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | initial settings for the new control |
{sap.ui.base.Event} | oControlEvent | |
{sap.ui.base.EventProvider} | oControlEvent.getSource | |
{object} | oControlEvent.getParameters |
sClassName
and enriches it with the information contained in oClassInfo
. oClassInfo
might contain the same kind of informations as described in Element.extend.
{string} | sClassName | name of the class to be created |
{object} | oClassInfo? | object literal with informations about the class |
{function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
{function} | the created class / constructor function |
{sap.ui.base.Metadata} | Metadata object describing this class |
oProperty
to the aggregation named properties
. {sap.ui.core.Control} | oProperty | the property to add; if empty, nothing is inserted |
{sap.landvisz.internal.DataContainer} | this to allow method chaining |
fnFunction
to the 'select' event of this sap.landvisz.internal.DataContainer
.. When called, the context of the event handler (its
this
) will be bound to oListener if specified otherwise to this sap.landvisz.internal.DataContainer
.
itself. the action to be carried out on selection of a tab
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.internal.DataContainer .itself. |
Returns:
{sap.landvisz.internal.DataContainer} | this to allow method chaining |
destroyProperties(): sap.landvisz.internal.DataContainer Destroys all the properties in the aggregation named properties
. Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
detachSelect(fnFunction, oListener): sap.landvisz.internal.DataContainer Detach event handler fnFunction
from the 'select' event of this sap.landvisz.internal.DataContainer
.
The passed function and listener object must match the ones used for event registration.
Parameters:{function} fnFunction The function to call, when the event occurs. {object} oListener Context object on which the given function had to be called.
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
fireSelect(mArguments?): sap.landvisz.internal.DataContainer Fire event select to attached listeners. Parameters:{Map} mArguments? the arguments to pass along with the event.
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
getHeader(): string Getter for property header
. Text of Navigation Header Default value is empty/undefined
Returns:{string} the value of property header
getProperties(): sap.ui.core.Control[] Getter for aggregation properties
.
test Returns:{sap.ui.core.Control[]}
getRenderingSize(): sap.landvisz.EntityCSSSize Getter for property renderingSize
. rendering size of the control Default value is sap.landvisz.EntityCSSSize.Regular
Returns:{sap.landvisz.EntityCSSSize} the value of property renderingSize
getSelected(): boolean Getter for property selected
. selected property of data header Default value is true
Returns:{boolean} the value of property selected
getType(): sap.landvisz.LandscapeObject Getter for property type
. type of landscape object Default value is empty/undefined
Returns:{sap.landvisz.LandscapeObject} the value of property type
indexOfProperty(oProperty): int Checks for the provided sap.ui.core.Control
in the aggregation named properties
and returns its index if found or -1 otherwise. Parameters:{sap.ui.core.Control} oProperty the property whose index is looked for.
Returns:{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertProperty(oProperty, iIndex): sap.landvisz.internal.DataContainer Inserts a property into the aggregation named properties
. Parameters:{sap.ui.core.Control} oProperty the property to insert; if empty, nothing is inserted {int} iIndex the 0
-based index the property should be inserted at; for a negative value of iIndex
, the property is inserted at position 0; for a value greater than the current size of the aggregation, the property is inserted at the last position
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
removeAllProperties(): sap.ui.core.Control[] Removes all the controls in the aggregation named properties
.
Additionally unregisters them from the hosting UIArea. Returns:{sap.ui.core.Control[]} an array of the removed elements (might be empty)
removeProperty(vProperty): sap.ui.core.Control Removes an property from the aggregation named properties
. Parameters:{int|string|sap.ui.core.Control} vProperty the property to remove or its index or id
Returns:{sap.ui.core.Control} the removed property or null
setHeader(sHeader): sap.landvisz.internal.DataContainer Setter for property header
. Default value is empty/undefined
Parameters:{string} sHeader new value for property header
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
setRenderingSize(oRenderingSize): sap.landvisz.internal.DataContainer Setter for property renderingSize
. Default value is sap.landvisz.EntityCSSSize.Regular
Parameters:{sap.landvisz.EntityCSSSize} oRenderingSize new value for property renderingSize
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
setSelected(bSelected): sap.landvisz.internal.DataContainer Setter for property selected
. Default value is true
Parameters:{boolean} bSelected new value for property selected
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining
setType(oType): sap.landvisz.internal.DataContainer Setter for property type
. Default value is empty/undefined
Parameters:{sap.landvisz.LandscapeObject} oType new value for property type
Returns:{sap.landvisz.internal.DataContainer} this
to allow method chaining