class sap.ui.ux3.ExactArea

Control sample: sap.ui.ux3.ExactArea
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/ExactArea
Application Component: CA-UI5-CTR

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.


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.ExactArea(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
toolbarVisible boolean true

Specifies whether the tool bar shall be visible

Visibility: public

Aggregations

Default Aggregation: content

Name Cardinality Type Description
content (default) 0..n sap.ui.core.Control

Arbitrary child controls of the content area

toolbarItems 0..n sap.ui.commons.ToolbarItem

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


Methods Overview

Method Description
addContent

Adds some content to the aggregation content.

addToolbarItem

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.

sap.ui.ux3.ExactArea.extend

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.

getContent

Gets content of aggregation content.

Arbitrary child controls of the content area

sap.ui.ux3.ExactArea.getMetadata

Returns a metadata object for class sap.ui.ux3.ExactArea.

getToolbarItems

Gets content of aggregation toolbarItems.

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

getToolbarVisible

Gets current value of property toolbarVisible.

Specifies whether the tool bar shall be visible

Default value is true.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

indexOfToolbarItem

Checks for the provided sap.ui.commons.ToolbarItem in the aggregation toolbarItems. and returns its index if found or -1 otherwise.

insertContent

Inserts a content into the aggregation content.

insertToolbarItem

Inserts a toolbarItem into the aggregation toolbarItems.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllToolbarItems

Removes all the controls from the aggregation toolbarItems.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

removeToolbarItem

Removes a toolbarItem from the aggregation toolbarItems.

setToolbarVisible

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.

addContent

Adds some content to the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to add; if empty, nothing is inserted

addToolbarItem

Adds some toolbarItem to the aggregation toolbarItems.

Param Type DefaultValue Description
oToolbarItem sap.ui.commons.ToolbarItem

The toolbarItem to add; if empty, nothing is inserted

destroyContent

Destroys all the content in the aggregation content.

destroyToolbarItems

Destroys all the toolbarItems in the aggregation toolbarItems.

sap.ui.ux3.ExactArea.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getContent

Gets content of aggregation content.

Arbitrary child controls of the content area

sap.ui.ux3.ExactArea.getMetadata

Returns a metadata object for class sap.ui.ux3.ExactArea.

getToolbarItems

Gets content of aggregation toolbarItems.

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

getToolbarVisible

Gets current value of property toolbarVisible.

Specifies whether the tool bar shall be visible

Default value is true.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content whose index is looked for

indexOfToolbarItem

Checks for the provided sap.ui.commons.ToolbarItem in the aggregation toolbarItems. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oToolbarItem sap.ui.commons.ToolbarItem

The toolbarItem whose index is looked for

insertContent

Inserts a content into the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to insert; if empty, nothing is inserted

iIndex int

The 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

insertToolbarItem

Inserts a toolbarItem into the aggregation toolbarItems.

Param Type DefaultValue Description
oToolbarItem sap.ui.commons.ToolbarItem

The toolbarItem to insert; if empty, nothing is inserted

iIndex int

The 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

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeAllToolbarItems

Removes all the controls from the aggregation toolbarItems.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.core.Control

The content to remove or its index or id

removeToolbarItem

Removes a toolbarItem from the aggregation toolbarItems.

Param Type DefaultValue Description
vToolbarItem int string sap.ui.commons.ToolbarItem

The toolbarItem to remove or its index or id

setToolbarVisible

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.

Param Type DefaultValue Description
bToolbarVisible boolean true

New value for property toolbarVisible