Class sap.uxap.ObjectPageHeaderActionButtonModule: sap/uxap/ObjectPageHeaderActionButton

extends Button

Button that can be used in the ObjectPageHeader action aggregation.


Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageHeaderActionButton(sId?, mSettings?)Constructor for a new ObjectPageHeaderActionButton.
Events borrowed from class sap.m.Button
press, tap
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.uxap.ObjectPageHeaderActionButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageHeaderActionButton with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageHeaderActionButton.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
getHideIcon()Gets current value of property hideIcon.
getHideText()Gets current value of property hideText.
getImportance()Gets current value of property importance.
setHideIcon(bHideIcon)Sets a new value for property hideIcon.
setHideText(bHideText)Sets a new value for property hideText.
setImportance(sImportance)Sets a new value for property importance.
Methods borrowed from class sap.m.Button
addAriaDescribedBy, addAriaLabelledBy, attachPress, attachTap, detachPress, detachTap, firePress, fireTap, getAccessibilityInfo, getActiveIcon, getAriaDescribedBy, getAriaLabelledBy, getEnabled, getIcon, getIconDensityAware, getIconFirst, getPopupAnchorDomRef, getText, getTextDirection, getType, getWidth, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setActiveIcon, setEnabled, setIcon, setIconDensityAware, setIconFirst, setText, setTextDirection, setType, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.uxap.ObjectPageHeaderActionButton(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • hideText : boolean (default: true)
    • hideIcon : boolean (default: false)
    • importance : sap.uxap.Importance (default: library.Importance.High)

In addition, all settings applicable to the base type sap.m.Button can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.uxap.ObjectPageHeaderActionButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.uxap.ObjectPageHeaderActionButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageHeaderActionButton.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getHideIcon(): boolean
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.

Returns:
{boolean} Value of property hideIcon
getHideText(): boolean
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.

Returns:
{boolean} Value of property hideText
getImportance(): sap.uxap.Importance
Gets current value of property importance.

Determines the order in which the button overflows.

Default value is library.Importance.High.

Since:
1.34.0
Returns:
{sap.uxap.Importance} Value of property importance
setHideIcon(bHideIcon): sap.uxap.ObjectPageHeaderActionButton
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.

Parameters:
{boolean}bHideIcon New value for property hideIcon
Returns:
{sap.uxap.ObjectPageHeaderActionButton} Reference to this in order to allow method chaining
setHideText(bHideText): sap.uxap.ObjectPageHeaderActionButton
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.

Parameters:
{boolean}bHideText New value for property hideText
Returns:
{sap.uxap.ObjectPageHeaderActionButton} Reference to this in order to allow method chaining
setImportance(sImportance): sap.uxap.ObjectPageHeaderActionButton
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 library.Importance.High.

Parameters:
{sap.uxap.Importance}sImportance New value for property importance
Since:
1.34.0
Returns:
{sap.uxap.ObjectPageHeaderActionButton} Reference to this in order to allow method chaining