A MasterPage is a sap.m.semantic.SemanticPage that supports semantic content of the following types:
Constructor for a new MasterPage
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.m.semantic.MasterPage(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 |
Name | Type | Default Value | Description |
---|---|---|---|
backgroundDesign | sap.m.PageBackgroundDesign | Standard | Determines the backgound color of the page. For more information, see sap.m.Page#backgroundDesign. |
enableScrolling | boolean | true | Visibility: public |
floatingFooter | boolean | false | Determines whether the floating footer behavior is enabled. If set to |
semanticRuleSet | sap.m.semantic.SemanticRuleSetType | Classic | Declares the type of semantic ruleset that will govern the styling and positioning of semantic content. |
showFooter | boolean | true | Hides or shows the page footer Visibility: public |
showNavButton | boolean | false | Visibility: public |
showSubHeader | boolean | true | Visibility: public |
title | string | See sap.m.Page#title Visibility: public |
|
titleLevel | sap.ui.core.TitleLevel | Auto | Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
addAction | 0..1 | sap.m.semantic.AddAction |
Add action |
cancelAction | 0..1 | sap.m.semantic.CancelAction |
Cancel action |
deleteAction | 0..1 | sap.m.semantic.DeleteAction |
Delete action |
editAction | 0..1 | sap.m.semantic.EditAction |
Edit action |
filter | 0..1 | sap.m.semantic.IFilter |
Filter action |
forwardAction | 0..1 | sap.m.semantic.ForwardAction |
Forward action |
group | 0..1 | sap.m.semantic.IGroup |
Group action |
mainAction | 0..1 | sap.m.semantic.MainAction |
Main action |
messagesIndicator | 0..1 | sap.m.semantic.MessagesIndicator |
MessagesIndicator |
multiSelectAction | 0..1 | sap.m.semantic.MultiSelectAction |
MultiSelect action |
negativeAction | 0..1 | sap.m.semantic.NegativeAction |
Negative action |
positiveAction | 0..1 | sap.m.semantic.PositiveAction |
Positive action |
saveAction | 0..1 | sap.m.semantic.SaveAction |
Save action |
sort | 0..1 | sap.m.semantic.ISort |
Sort action |
Name | Cardinality | Type | Description |
---|---|---|---|
content | 0..n | sap.ui.core.Control | |
customFooterContent | 0..n | sap.m.Button |
Custom footer buttons |
customHeaderContent | 0..n | sap.m.Button |
Custom header buttons |
landmarkInfo | 0..1 | sap.m.PageAccessibleLandmarkInfo |
Accessible landmark settings to be applied to the containers of the If not set, no landmarks will be written. |
subHeader | 0..1 | sap.m.IBar |
Method | Description |
---|---|
destroyAddAction |
Destroys the addAction in the aggregation addAction. |
destroyCancelAction |
Destroys the cancelAction in the aggregation cancelAction. |
destroyDeleteAction |
Destroys the deleteAction in the aggregation deleteAction. |
destroyEditAction |
Destroys the editAction in the aggregation editAction. |
destroyFilter |
Destroys the filter in the aggregation filter. |
destroyForwardAction |
Destroys the forwardAction in the aggregation forwardAction. |
destroyGroup |
Destroys the group in the aggregation group. |
destroyMainAction |
Destroys the mainAction in the aggregation mainAction. |
destroyMessagesIndicator |
Destroys the messagesIndicator in the aggregation messagesIndicator. |
destroyMultiSelectAction |
Destroys the multiSelectAction in the aggregation multiSelectAction. |
destroyNegativeAction |
Destroys the negativeAction in the aggregation negativeAction. |
destroyPositiveAction |
Destroys the positiveAction in the aggregation positiveAction. |
destroySaveAction |
Destroys the saveAction in the aggregation saveAction. |
destroySort |
Destroys the sort in the aggregation sort. |
sap.m.semantic.MasterPage.extend |
Creates a new subclass of class sap.m.semantic.MasterPage with name
|
getAddAction |
Gets content of aggregation addAction. Add action |
getCancelAction |
Gets content of aggregation cancelAction. Cancel action |
getDeleteAction |
Gets content of aggregation deleteAction. Delete action |
getEditAction |
Gets content of aggregation editAction. Edit action |
getFilter |
Gets content of aggregation filter. Filter action |
getForwardAction |
Gets content of aggregation forwardAction. Forward action |
getGroup |
Gets content of aggregation group. Group action |
getMainAction |
Gets content of aggregation mainAction. Main action |
getMessagesIndicator |
Gets content of aggregation messagesIndicator. MessagesIndicator |
sap.m.semantic.MasterPage.getMetadata |
Returns a metadata object for class sap.m.semantic.MasterPage. |
getMultiSelectAction |
Gets content of aggregation multiSelectAction. MultiSelect action |
getNegativeAction |
Gets content of aggregation negativeAction. Negative action |
getPositiveAction |
Gets content of aggregation positiveAction. Positive action |
getSaveAction |
Gets content of aggregation saveAction. Save action |
getSort |
Gets content of aggregation sort. Sort action |
setAddAction |
Sets the aggregated addAction. |
setCancelAction |
Sets the aggregated cancelAction. |
setDeleteAction |
Sets the aggregated deleteAction. |
setEditAction |
Sets the aggregated editAction. |
setFilter |
Sets the aggregated filter. |
setForwardAction |
Sets the aggregated forwardAction. |
setGroup |
Sets the aggregated group. |
setMainAction |
Sets the aggregated mainAction. |
setMessagesIndicator |
Sets the aggregated messagesIndicator. |
setMultiSelectAction |
Sets the aggregated multiSelectAction. |
setNegativeAction |
Sets the aggregated negativeAction. |
setPositiveAction |
Sets the aggregated positiveAction. |
setSaveAction |
Sets the aggregated saveAction. |
setSort |
Sets the aggregated sort. |
Creates a new subclass of class sap.m.semantic.MasterPage with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.m.semantic.SemanticPage.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 |
Returns a metadata object for class sap.m.semantic.MasterPage.
Sets the aggregated addAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAddAction | sap.m.semantic.AddAction |
The addAction to set |
Sets the aggregated cancelAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCancelAction | sap.m.semantic.CancelAction |
The cancelAction to set |
Sets the aggregated deleteAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDeleteAction | sap.m.semantic.DeleteAction |
The deleteAction to set |
Sets the aggregated editAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oEditAction | sap.m.semantic.EditAction |
The editAction to set |
Sets the aggregated filter.
Param | Type | DefaultValue | Description |
---|---|---|---|
oFilter | sap.m.semantic.IFilter |
The filter to set |
Sets the aggregated forwardAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oForwardAction | sap.m.semantic.ForwardAction |
The forwardAction to set |
Sets the aggregated group.
Param | Type | DefaultValue | Description |
---|---|---|---|
oGroup | sap.m.semantic.IGroup |
The group to set |
Sets the aggregated mainAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMainAction | sap.m.semantic.MainAction |
The mainAction to set |
Sets the aggregated messagesIndicator.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMessagesIndicator | sap.m.semantic.MessagesIndicator |
The messagesIndicator to set |
Sets the aggregated multiSelectAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oMultiSelectAction | sap.m.semantic.MultiSelectAction |
The multiSelectAction to set |
Sets the aggregated negativeAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oNegativeAction | sap.m.semantic.NegativeAction |
The negativeAction to set |
Sets the aggregated positiveAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPositiveAction | sap.m.semantic.PositiveAction |
The positiveAction to set |
Sets the aggregated saveAction.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSaveAction | sap.m.semantic.SaveAction |
The saveAction to set |
Sets the aggregated sort.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSort | sap.m.semantic.ISort |
The sort to set |