Class sap.suite.ui.commons.NoteTakerFeederModule: sap/suite/ui/commons/NoteTakerFeeder

extends Control

This control allows you to enter a quick note and N note cards.

Deprecated API:Since version 1.32. Deprecated. Standard Fiori technology should be used.

Constructor Summary
new sap.suite.ui.commons.NoteTakerFeeder(sId?, mSettings?)Constructor for a new NoteTakerFeeder.
Event Summary
addNote(oControlEvent)The event is fired when a user chooses the Add button in the control.
attachmentClick(oControlEvent)The event is fired when a user presses the attachment link.
attachmentDelete(oControlEvent)The event is fired when a user presses the Delete button in the Feeder card.
attachmentSelect(oControlEvent)The event is fired when the value of attached file has been changed.
attachmentUploadComplete(oControlEvent)The event is fired when the upload of the file is completed.
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.suite.ui.commons.NoteTakerFeeder.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.NoteTakerFeeder with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.NoteTakerFeeder.getMetadata()Returns a metadata object for class sap.suite.ui.commons.NoteTakerFeeder.
attachAddNote(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'addNote' event of this sap.suite.ui.commons.NoteTakerFeeder.
attachAttachmentClick(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerFeeder.
attachAttachmentDelete(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTakerFeeder.
attachAttachmentSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTakerFeeder.
attachAttachmentUploadComplete(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTakerFeeder.
detachAddNote(fnFunction, oListener)Detach event handler fnFunction from the 'addNote' event of this sap.suite.ui.commons.NoteTakerFeeder.
detachAttachmentClick(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerFeeder.
detachAttachmentDelete(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTakerFeeder.
detachAttachmentSelect(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTakerFeeder.
detachAttachmentUploadComplete(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTakerFeeder.
fireAddNote(mArguments?)Fire event addNote to attached listeners.
fireAttachmentClick(mArguments?)Fire event attachmentClick to attached listeners.
fireAttachmentDelete(mArguments?)Fire event attachmentDelete to attached listeners.
fireAttachmentSelect(mArguments?)Fire event attachmentSelect to attached listeners.
fireAttachmentUploadComplete(mArguments?)Fire event attachmentUploadComplete to attached listeners.
getAttachmentName()Getter for property attachmentName.
getAttachmentUploadUrl()Getter for property attachmentUploadUrl.
getBody()Getter for property body.
getTags()Getter for property tags.
getThumbDown()Getter for property thumbDown.
getThumbUp()Getter for property thumbUp.
getTitle()Getter for property title.
setAttachmentName(sAttachmentName)Setter for property attachmentName.
setAttachmentUploadUrl(sAttachmentUploadUrl)Setter for property attachmentUploadUrl.
setBody(sBody)Setter for property body.
setTags(oTags)Setter for property tags.
setThumbDown(bThumbDown)Setter for property thumbDown.
setThumbUp(bThumbUp)Setter for property thumbUp.
setTitle(sTitle)Setter for property title.
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.suite.ui.commons.NoteTakerFeeder(sId?, mSettings?)
Constructor for a new NoteTakerFeeder.

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
        • addNote : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • attachmentSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • attachmentUploadComplete : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • attachmentDelete : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • attachmentClick : 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
      Deprecated:
      Since version 1.32. Deprecated. Standard Fiori technology should be used.
      Event Detail
      addNote(oControlEvent)
      The event is fired when a user chooses the Add button in the control.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.title The title of the note to be added.
      {string}oControlEvent.getParameters.body The text of the note to be added.
      {object}oControlEvent.getParameters.timestamp The timestamp of the note to be added.
      {boolean}oControlEvent.getParameters.thumbUp If set to true, a new card should be marked as positive one.
      {boolean}oControlEvent.getParameters.thumbDown If set to true, a new card should be marked as negative one.
      {string}oControlEvent.getParameters.attachmentFilename Stores the attachment file name for a new card.
      attachmentClick(oControlEvent)
      The event is fired when a user presses the attachment link.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.filename A name of the attached file.
      attachmentDelete(oControlEvent)
      The event is fired when a user presses the Delete button in the Feeder card.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.filename A name of the attached file.
      attachmentSelect(oControlEvent)
      The event is fired when the value of attached file has been changed.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.filename A name of the attached file.
      attachmentUploadComplete(oControlEvent)
      The event is fired when the upload of the file is completed. However this covers only the client side of the Upload process and does not give any success status from the server.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.response The response message that comes from the server. On the server side this response has to be put within the "body" tags of the response document of the iFrame. It can consist of a return code and an optional message. This does not work in cross-domain scenarios.
      Method Detail
      sap.suite.ui.commons.NoteTakerFeeder.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.NoteTakerFeeder 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.suite.ui.commons.NoteTakerFeeder.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.NoteTakerFeeder.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachAddNote(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerFeeder
      Attach event handler fnFunction to the 'addNote' event of this sap.suite.ui.commons.NoteTakerFeeder.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerFeeder.
      itself.

      The event is fired when a user chooses the Add button in the control.

      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.suite.ui.commons.NoteTakerFeeder.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      attachAttachmentClick(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerFeeder
      Attach event handler fnFunction to the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerFeeder.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerFeeder.
      itself.

      The event is fired when a user presses the attachment link.

      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.suite.ui.commons.NoteTakerFeeder.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      attachAttachmentDelete(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerFeeder
      Attach event handler fnFunction to the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTakerFeeder.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerFeeder.
      itself.

      The event is fired when a user presses the Delete button in the Feeder card.

      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.suite.ui.commons.NoteTakerFeeder.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      attachAttachmentSelect(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerFeeder
      Attach event handler fnFunction to the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTakerFeeder.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerFeeder.
      itself.

      The event is fired when the value of attached file has been changed.

      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.suite.ui.commons.NoteTakerFeeder.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      attachAttachmentUploadComplete(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerFeeder
      Attach event handler fnFunction to the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTakerFeeder.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerFeeder.
      itself.

      The event is fired when the upload of the file is completed. However this covers only the client side of the Upload process and does not give any success status from the server.

      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.suite.ui.commons.NoteTakerFeeder.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      detachAddNote(fnFunction, oListener): sap.suite.ui.commons.NoteTakerFeeder
      Detach event handler fnFunction from the 'addNote' event of this sap.suite.ui.commons.NoteTakerFeeder.

      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.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      detachAttachmentClick(fnFunction, oListener): sap.suite.ui.commons.NoteTakerFeeder
      Detach event handler fnFunction from the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerFeeder.

      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.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      detachAttachmentDelete(fnFunction, oListener): sap.suite.ui.commons.NoteTakerFeeder
      Detach event handler fnFunction from the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTakerFeeder.

      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.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      detachAttachmentSelect(fnFunction, oListener): sap.suite.ui.commons.NoteTakerFeeder
      Detach event handler fnFunction from the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTakerFeeder.

      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.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      detachAttachmentUploadComplete(fnFunction, oListener): sap.suite.ui.commons.NoteTakerFeeder
      Detach event handler fnFunction from the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTakerFeeder.

      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.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      fireAddNote(mArguments?): sap.suite.ui.commons.NoteTakerFeeder
      Fire event addNote to attached listeners.

      Expects following event parameters:

      • 'title' of type string The title of the note to be added.
      • 'body' of type string The text of the note to be added.
      • 'timestamp' of type object The timestamp of the note to be added.
      • 'thumbUp' of type boolean If set to true, a new card should be marked as positive one.
      • 'thumbDown' of type boolean If set to true, a new card should be marked as negative one.
      • 'attachmentFilename' of type string Stores the attachment file name for a new card.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      fireAttachmentClick(mArguments?): sap.suite.ui.commons.NoteTakerFeeder
      Fire event attachmentClick to attached listeners.

      Expects following event parameters:

      • 'filename' of type string A name of the attached file.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      fireAttachmentDelete(mArguments?): sap.suite.ui.commons.NoteTakerFeeder
      Fire event attachmentDelete to attached listeners.

      Expects following event parameters:

      • 'filename' of type string A name of the attached file.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      fireAttachmentSelect(mArguments?): sap.suite.ui.commons.NoteTakerFeeder
      Fire event attachmentSelect to attached listeners.

      Expects following event parameters:

      • 'filename' of type string A name of the attached file.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      fireAttachmentUploadComplete(mArguments?): sap.suite.ui.commons.NoteTakerFeeder
      Fire event attachmentUploadComplete to attached listeners.

      Expects following event parameters:

      • 'response' of type string The response message that comes from the server. On the server side this response has to be put within the "body" tags of the response document of the iFrame. It can consist of a return code and an optional message. This does not work in cross-domain scenarios.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      getAttachmentName(): string
      Getter for property attachmentName. The attachment property name for identification on the server side after sending data to the server.

      Default value is attachment

      Returns:
      {string} the value of property attachmentName
      getAttachmentUploadUrl(): string
      Getter for property attachmentUploadUrl. Sets the upload attachment URL for a new card.

      Default value is empty/undefined

      Returns:
      {string} the value of property attachmentUploadUrl
      getBody(): string
      Getter for property body. The text inside the note card.

      Default value is empty/undefined

      Returns:
      {string} the value of property body
      getTags(): object
      Getter for property tags. The list of tags selected for addition to a new note card.

      Default value is []

      Returns:
      {object} the value of property tags
      getThumbDown(): boolean
      Getter for property thumbDown. Sets negative indication for a new note.

      Default value is empty/undefined

      Returns:
      {boolean} the value of property thumbDown
      getThumbUp(): boolean
      Getter for property thumbUp. Sets positive indication for a new note.

      Default value is empty/undefined

      Returns:
      {boolean} the value of property thumbUp
      getTitle(): string
      Getter for property title. This text is the header of a new note.

      Default value is empty/undefined

      Returns:
      {string} the value of property title
      setAttachmentName(sAttachmentName): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property attachmentName.

      Default value is attachment

      Parameters:
      {string}sAttachmentName new value for property attachmentName
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setAttachmentUploadUrl(sAttachmentUploadUrl): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property attachmentUploadUrl.

      Default value is empty/undefined

      Parameters:
      {string}sAttachmentUploadUrl new value for property attachmentUploadUrl
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setBody(sBody): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property body.

      Default value is empty/undefined

      Parameters:
      {string}sBody new value for property body
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setTags(oTags): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property tags.

      Default value is []

      Parameters:
      {object}oTags new value for property tags
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setThumbDown(bThumbDown): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property thumbDown.

      Default value is empty/undefined

      Parameters:
      {boolean}bThumbDown new value for property thumbDown
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setThumbUp(bThumbUp): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property thumbUp.

      Default value is empty/undefined

      Parameters:
      {boolean}bThumbUp new value for property thumbUp
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining
      setTitle(sTitle): sap.suite.ui.commons.NoteTakerFeeder
      Setter for property title.

      Default value is empty/undefined

      Parameters:
      {string}sTitle new value for property title
      Returns:
      {sap.suite.ui.commons.NoteTakerFeeder}this to allow method chaining