Class sap.ushell.ui.footerbar.AddBookmarkButtonModule: sap/ushell/ui/footerbar/AddBookmarkButton

extends Button

A button to be displayed in the application footer. Clicking the button opens a dialog box allowing the user to save the app state, so that the app can be launched in this state directly from the launchpad.

Constructor Summary
new sap.ushell.ui.footerbar.AddBookmarkButton(sId?, mSettings?)Constructor for a new ui/footerbar/AddBookmarkButton.
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.ushell.ui.footerbar.AddBookmarkButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ushell.ui.footerbar.AddBookmarkButton with name sClassName and enriches it with the information contained in oClassInfo.
sap.ushell.ui.footerbar.AddBookmarkButton.getMetadata()Returns a metadata object for class sap.ushell.ui.footerbar.AddBookmarkButton.
getAfterPressHandler()Getter for property afterPressHandler.
getAppData()Getter for property appData.
getBeforePressHandler()Getter for property beforePressHandler.
getCustomUrl()Getter for property customUrl.
getInfo()Getter for property info.
getKeywords()Getter for property keywords.
getNumberUnit()Getter for property numberUnit.
getServiceRefreshInterval()Getter for property serviceRefreshInterval.
getServiceUrl()Getter for property serviceUrl.
getShowGroupSelection()Getter for property showGroupSelection.
getSubtitle()Getter for property subtitle.
getTileIcon()Getter for property tileIcon.
getTitle()Getter for property title.
setAfterPressHandler(oAfterPressHandler)Setter for property afterPressHandler.
setAppData(oAppData)Setter for property appData.
setBeforePressHandler(oBeforePressHandler)Setter for property beforePressHandler.
setCustomUrl(oCustomUrl)Setter for property customUrl.
setInfo(sInfo)Setter for property info.
setKeywords(sKeywords)Setter for property keywords.
setNumberUnit(sNumberUnit)Setter for property numberUnit.
setServiceRefreshInterval(sServiceRefreshInterval)Setter for property serviceRefreshInterval.
setServiceUrl(oServiceUrl)Setter for property serviceUrl.
setShowGroupSelection(bShowGroupSelection)Setter for property showGroupSelection.
setSubtitle(sSubtitle)Setter for property subtitle.
setTileIcon(sTileIcon)Setter for property tileIcon.
setTitle(sTitle)Setter for property title.
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.ushell.ui.footerbar.AddBookmarkButton(sId?, mSettings?)
Constructor for a new ui/footerbar/AddBookmarkButton.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

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.ushell.ui.footerbar.AddBookmarkButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ushell.ui.footerbar.AddBookmarkButton with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of informations as described in Element.extend.

Parameters:
{string}sClassName name of the class to be created
{object}oClassInfo? object literal with informations about the class
{function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
Returns:
{function} the created class / constructor function
sap.ushell.ui.footerbar.AddBookmarkButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ushell.ui.footerbar.AddBookmarkButton.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getAfterPressHandler(): any
Getter for property afterPressHandler. A callback function to be called after the press handler called upon clicking the button.

Default value is empty/undefined

Returns:
{any} the value of property afterPressHandler
getAppData(): object
Getter for property appData. Deprecated – an object containing application information properties.

Default value is empty/undefined

Returns:
{object} the value of property appData
getBeforePressHandler(): any
Getter for property beforePressHandler. A callback function to be called prior to the press handler upon clicking the button.

Default value is empty/undefined

Returns:
{any} the value of property beforePressHandler
getCustomUrl(): any
Getter for property customUrl. A customized target URL for the tile.

Default value is empty/undefined

Returns:
{any} the value of property customUrl
getInfo(): string
Getter for property info. Text to be displayed at the bottom of the tile.

Default value is empty/undefined

Returns:
{string} the value of property info
getKeywords(): string
Getter for property keywords. The keywords based on which the future tile should be indexed and filtered.

Default value is empty/undefined

Returns:
{string} the value of property keywords
getNumberUnit(): string
Getter for property numberUnit. For dynamic tile, the unit to be displayed below the number, for example, USD.

Default value is empty/undefined

Returns:
{string} the value of property numberUnit
getServiceRefreshInterval(): string
Getter for property serviceRefreshInterval. Number of seconds after which dynamic content is read from the data source and the display is refreshed.

Default value is empty/undefined

Returns:
{string} the value of property serviceRefreshInterval
getServiceUrl(): any
Getter for property serviceUrl. URL of an OData service from which data should be read.

Default value is empty/undefined

Returns:
{any} the value of property serviceUrl
getShowGroupSelection(): boolean
Getter for property showGroupSelection. Defines whether to display the group selection control within the Save as Tile dialog box.

Default value is true

Returns:
{boolean} the value of property showGroupSelection
getSubtitle(): string
Getter for property subtitle. Subtitle to be displayed below the tile title.

Default value is empty/undefined

Returns:
{string} the value of property subtitle
getTileIcon(): string
Getter for property tileIcon. Icon to be desplied in the Tile.

Default value is empty/undefined

Returns:
{string} the value of property tileIcon
getTitle(): string
Getter for property title. Title to be displayed on the tile.

Default value is empty/undefined

Returns:
{string} the value of property title
setAfterPressHandler(oAfterPressHandler): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property afterPressHandler.

Default value is empty/undefined

Parameters:
{any}oAfterPressHandler new value for property afterPressHandler
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setAppData(oAppData): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property appData.

Default value is empty/undefined

Parameters:
{object}oAppData new value for property appData
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setBeforePressHandler(oBeforePressHandler): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property beforePressHandler.

Default value is empty/undefined

Parameters:
{any}oBeforePressHandler new value for property beforePressHandler
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setCustomUrl(oCustomUrl): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property customUrl.

Default value is empty/undefined

Parameters:
{any}oCustomUrl new value for property customUrl
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setInfo(sInfo): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property info.

Default value is empty/undefined

Parameters:
{string}sInfo new value for property info
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setKeywords(sKeywords): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property keywords.

Default value is empty/undefined

Parameters:
{string}sKeywords new value for property keywords
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setNumberUnit(sNumberUnit): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property numberUnit.

Default value is empty/undefined

Parameters:
{string}sNumberUnit new value for property numberUnit
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setServiceRefreshInterval(sServiceRefreshInterval): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property serviceRefreshInterval.

Default value is empty/undefined

Parameters:
{string}sServiceRefreshInterval new value for property serviceRefreshInterval
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setServiceUrl(oServiceUrl): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property serviceUrl.

Default value is empty/undefined

Parameters:
{any}oServiceUrl new value for property serviceUrl
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setShowGroupSelection(bShowGroupSelection): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property showGroupSelection.

Default value is true

Parameters:
{boolean}bShowGroupSelection new value for property showGroupSelection
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setSubtitle(sSubtitle): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property subtitle.

Default value is empty/undefined

Parameters:
{string}sSubtitle new value for property subtitle
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setTileIcon(sTileIcon): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property tileIcon.

Default value is empty/undefined

Parameters:
{string}sTileIcon new value for property tileIcon
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining
setTitle(sTitle): sap.ushell.ui.footerbar.AddBookmarkButton
Setter for property title.

Default value is empty/undefined

Parameters:
{string}sTitle new value for property title
Returns:
{sap.ushell.ui.footerbar.AddBookmarkButton}this to allow method chaining