Class sap.ushell.ui.appfinder.AppBoxModule: sap/ushell/ui/appfinder/AppBox

extends Control

Add your documentation for the newui/appfinder/AppBox

Constructor Summary
new sap.ushell.ui.appfinder.AppBox(sId?, mSettings?)Constructor for a new ui/appfinder/AppBox.
Event Summary
afterRendering(oControlEvent)
press(oControlEvent)
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.appfinder.AppBox.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ushell.ui.appfinder.AppBox with name sClassName and enriches it with the information contained in oClassInfo.
sap.ushell.ui.appfinder.AppBox.getMetadata()Returns a metadata object for class sap.ushell.ui.appfinder.AppBox.
attachAfterRendering(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'afterRendering' event of this sap.ushell.ui.appfinder.AppBox.
attachPress(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'press' event of this sap.ushell.ui.appfinder.AppBox.
destroyPinButton()Destroys the pinButton in the aggregation named pinButton.
detachAfterRendering(fnFunction, oListener)Detach event handler fnFunction from the 'afterRendering' event of this sap.ushell.ui.appfinder.AppBox.
detachPress(fnFunction, oListener)Detach event handler fnFunction from the 'press' event of this sap.ushell.ui.appfinder.AppBox.
fireAfterRendering(mArguments?)Fire event afterRendering to attached listeners.
firePress(mArguments?)Fire event press to attached listeners.
getPinButton()Getter for aggregation pinButton.
getTitle()Getter for property title.
getUrl()Getter for property url.
setPinButton(oPinButton)Setter for the aggregated pinButton.
setTitle(sTitle)Setter for property title.
setUrl(sUrl)Setter for property url.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, 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, exit, 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.appfinder.AppBox(sId?, mSettings?)
Constructor for a new ui/appfinder/AppBox.

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:

  • Properties
  • Aggregations
  • Associations
    • Events
      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • afterRendering : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    Parameters:
    {string}sId? id for the new control, generated automatically if no id is given
    {object}mSettings? initial settings for the new control
    Event Detail
    afterRendering(oControlEvent)
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    press(oControlEvent)
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.ushell.ui.appfinder.AppBox.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.ushell.ui.appfinder.AppBox 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.appfinder.AppBox.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.ushell.ui.appfinder.AppBox.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachAfterRendering(oData?, fnFunction, oListener?): sap.ushell.ui.appfinder.AppBox
    Attach event handler fnFunction to the 'afterRendering' event of this sap.ushell.ui.appfinder.AppBox.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ushell.ui.appfinder.AppBox.
    itself.
    Parameters:
    {object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.ushell.ui.appfinder.AppBox.
    itself.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    attachPress(oData?, fnFunction, oListener?): sap.ushell.ui.appfinder.AppBox
    Attach event handler fnFunction to the 'press' event of this sap.ushell.ui.appfinder.AppBox.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.ushell.ui.appfinder.AppBox.
    itself.
    Parameters:
    {object}oData? An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener? Context object to call the event handler with. Defaults to this sap.ushell.ui.appfinder.AppBox.
    itself.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    destroyPinButton(): sap.ushell.ui.appfinder.AppBox
    Destroys the pinButton in the aggregation named pinButton.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    detachAfterRendering(fnFunction, oListener): sap.ushell.ui.appfinder.AppBox
    Detach event handler fnFunction from the 'afterRendering' event of this sap.ushell.ui.appfinder.AppBox.

    The passed function and listener object must match the ones used for event registration.

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    detachPress(fnFunction, oListener): sap.ushell.ui.appfinder.AppBox
    Detach event handler fnFunction from the 'press' event of this sap.ushell.ui.appfinder.AppBox.

    The passed function and listener object must match the ones used for event registration.

    Parameters:
    {function}fnFunction The function to call, when the event occurs.
    {object}oListener Context object on which the given function had to be called.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    fireAfterRendering(mArguments?): sap.ushell.ui.appfinder.AppBox
    Fire event afterRendering to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    firePress(mArguments?): sap.ushell.ui.appfinder.AppBox
    Fire event press to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    getPinButton(): sap.m.Button
    Getter for aggregation pinButton.
    Returns:
    {sap.m.Button}
    getTitle(): string
    Getter for property title.

    Default value is empty/undefined

    Returns:
    {string} the value of property title
    getUrl(): string
    Getter for property url.

    Default value is empty/undefined

    Returns:
    {string} the value of property url
    setPinButton(oPinButton): sap.ushell.ui.appfinder.AppBox
    Setter for the aggregated pinButton.
    Parameters:
    {sap.m.Button}oPinButton
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    setTitle(sTitle): sap.ushell.ui.appfinder.AppBox
    Setter for property title.

    Default value is empty/undefined

    Parameters:
    {string}sTitle new value for property title
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining
    setUrl(sUrl): sap.ushell.ui.appfinder.AppBox
    Setter for property url.

    Default value is empty/undefined

    Parameters:
    {string}sUrl new value for property url
    Returns:
    {sap.ushell.ui.appfinder.AppBox}this to allow method chaining