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 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 |
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. |
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
|
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 |
indexOfContent |
Checks for the provided |
indexOfToolbarItem |
Checks for the provided |
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 Default value is |
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 |
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 |
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 |
Gets content of aggregation toolbarItems.
Tool bar items which shall be shown in the tool bar.
Gets current value of property toolbarVisible.
Specifies whether the tool bar shall be visible
Default value is true
.
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 |
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 |
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 |
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 |
Removes all the controls from the aggregation content.
Additionally, it unregisters them from the hosting UIArea.
Removes all the controls from the aggregation toolbarItems.
Additionally, it unregisters them from the hosting UIArea.
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 |
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 |
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 |