class sap.uxap.ObjectPageHeaderActionButton

Visiblity: public
UX Guidelines:
Implements: sap.m.IOverflowToolbarContent
Available since: N/A
Extends: sap.m.Button
Module: sap/uxap/ObjectPageHeaderActionButton
Application Component: CA-UI5-CTR

A Button that is used in the actions aggregation of the sap.uxap.ObjectPageHeader.

The button is designed to be used with sap.uxap.ObjectPageHeader and any usage outside the intended context is not recommended.


Constructor

Constructor for a new ObjectPageHeaderActionButton.

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.uxap.ObjectPageHeaderActionButton(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
hideIcon boolean false

Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Visibility: public
hideText boolean true

Hide the button text when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Visibility: public
importance sap.uxap.Importance High

Determines the order in which the button overflows.

Since: 1.34.0.

Visibility: public

Methods Overview

Method Description
sap.uxap.ObjectPageHeaderActionButton.extend

Creates a new subclass of class sap.uxap.ObjectPageHeaderActionButton 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.Button.extend.

getHideIcon

Gets current value of property hideIcon.

Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Default value is false.

getHideText

Gets current value of property hideText.

Hide the button text when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Default value is true.

getImportance

Gets current value of property importance.

Determines the order in which the button overflows.

Default value is High.

sap.uxap.ObjectPageHeaderActionButton.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.

setHideIcon

Sets a new value for property hideIcon.

Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

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

Default value is false.

setHideText

Sets a new value for property hideText.

Hide the button text when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

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

Default value is true.

setImportance

Sets a new value for property importance.

Determines the order in which the button overflows.

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

Default value is High.

sap.uxap.ObjectPageHeaderActionButton.extend

Creates a new subclass of class sap.uxap.ObjectPageHeaderActionButton 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.Button.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

getHideIcon

Gets current value of property hideIcon.

Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Default value is false.

getHideText

Gets current value of property hideText.

Hide the button text when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

Default value is true.

getImportance

Gets current value of property importance.

Determines the order in which the button overflows.

Default value is High.

sap.uxap.ObjectPageHeaderActionButton.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.

setHideIcon

Sets a new value for property hideIcon.

Hide the button icon when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display texts only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

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

Default value is false.

Param Type DefaultValue Description
bHideIcon boolean false

New value for property hideIcon

setHideText

Sets a new value for property hideText.

Hide the button text when rendered into the headerTitle part of the ObjectPageLayout. This is useful if you want to display icons only in the headerTitle part but still want to display text + icon in the actionSheet that appears when not enough space is available on the screen for displaying all actions.

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
bHideText boolean true

New value for property hideText

setImportance

Sets a new value for property importance.

Determines the order in which the button overflows.

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

Default value is High.

Param Type DefaultValue Description
sImportance sap.uxap.Importance High

New value for property importance