Class sap.ui.ux3.ExactAreaModule: sap/ui/ux3/ExactArea

extends Control

Consists of two sections: A tool bar and a content area where arbitrary controls can be added. The ExactArea is intended to be used for the Exact design approach but alternatively also in a stand alone version.
Deprecated API:
Since version 1.38.
Experimental API:
Since version 1.6. API is not yet finished and might change completely
Constructor Summary
new sap.ui.ux3.ExactArea(sId?, mSettings?)Constructor for a new ExactArea.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.ExactArea.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.ExactArea with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.ExactArea.getMetadata()Returns a metadata object for class sap.ui.ux3.ExactArea.
addContent(oContent)Adds some content to the aggregation content.
addToolbarItem(oToolbarItem)Adds some toolbarItem to the aggregation toolbarItems.
destroyContent()Destroys all the content in the aggregation content.
destroyToolbarItems()Destroys all the toolbarItems in the aggregation toolbarItems.
getContent()Gets content of aggregation content.
getToolbarItems()Gets content of aggregation toolbarItems.
getToolbarVisible()Gets current value of property toolbarVisible.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
indexOfToolbarItem(oToolbarItem)Checks for the provided sap.ui.commons.ToolbarItem in the aggregation toolbarItems.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
insertToolbarItem(oToolbarItem, iIndex)Inserts a toolbarItem into the aggregation toolbarItems.
removeAllContent()Removes all the controls from the aggregation content.
removeAllToolbarItems()Removes all the controls from the aggregation toolbarItems.
removeContent(vContent)Removes a content from the aggregation content.
removeToolbarItem(vToolbarItem)Removes a toolbarItem from the aggregation toolbarItems.
setToolbarVisible(bToolbarVisible)Sets a new value for property toolbarVisible.
Constructor Detail
new sap.ui.ux3.ExactArea(sId?, mSettings?)

Constructor for a new ExactArea.

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:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.ux3.ExactArea.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.ux3.ExactArea 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.ux3.ExactArea.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.ExactArea.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.ui.ux3.ExactArea
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
addToolbarItem(oToolbarItem): sap.ui.ux3.ExactArea
Adds some toolbarItem to the aggregation toolbarItems.
Parameters:
sap.ui.commons.ToolbarItemoToolbarItemthe toolbarItem to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
destroyContent(): sap.ui.ux3.ExactArea
Destroys all the content in the aggregation content.
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
destroyToolbarItems(): sap.ui.ux3.ExactArea
Destroys all the toolbarItems in the aggregation toolbarItems.
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

Arbitrary child controls of the content area

Returns:
sap.ui.core.Control[]
getToolbarItems(): sap.ui.commons.ToolbarItem[]

Gets content of aggregation toolbarItems.

Tool bar items which shall be shown in the tool bar.

Returns:
sap.ui.commons.ToolbarItem[]
getToolbarVisible(): boolean

Gets current value of property toolbarVisible.

Specifies whether the tool bar shall be visible

Default value is true.

Returns:
booleanValue of property toolbarVisible
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfToolbarItem(oToolbarItem): int
Checks for the provided sap.ui.commons.ToolbarItem in the aggregation toolbarItems. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.commons.ToolbarItemoToolbarItemThe toolbarItem whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.ux3.ExactArea
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
insertToolbarItem(oToolbarItem, iIndex): sap.ui.ux3.ExactArea
Inserts a toolbarItem into the aggregation toolbarItems.
Parameters:
sap.ui.commons.ToolbarItemoToolbarItemthe toolbarItem to insert; if empty, nothing is inserted
intiIndexthe 0-based index the toolbarItem should be inserted at; for a negative value of iIndex, the toolbarItem is inserted at position 0; for a value greater than the current size of the aggregation, the toolbarItem is inserted at the last position
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining
removeAllContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllToolbarItems(): sap.ui.commons.ToolbarItem[]

Removes all the controls from the aggregation toolbarItems.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.commons.ToolbarItem[]An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
int|string|sap.ui.core.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
removeToolbarItem(vToolbarItem): sap.ui.commons.ToolbarItem
Removes a toolbarItem from the aggregation toolbarItems.
Parameters:
int|string|sap.ui.commons.ToolbarItemvToolbarItemThe toolbarItem to remove or its index or id
Returns:
sap.ui.commons.ToolbarItemThe removed toolbarItem or null
setToolbarVisible(bToolbarVisible): sap.ui.ux3.ExactArea

Sets a new value for property toolbarVisible.

Specifies whether the tool bar shall be visible

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

Default value is true.

Parameters:
booleanbToolbarVisibleNew value for property toolbarVisible
Returns:
sap.ui.ux3.ExactAreaReference to this in order to allow method chaining