Class sap.suite.ui.commons.NoteTakerModule: sap/suite/ui/commons/NoteTaker

extends Control

This control allows you to create and store your notes for further reference.

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

Constructor Summary
new sap.suite.ui.commons.NoteTaker(sId?, mSettings?)Constructor for a new NoteTaker.
Event Summary
addCard(oControlEvent)The event is fired when a new card is added if no data binding is available.
attachmentClick(oControlEvent)The event is fired when a user presses the attachment link.
attachmentDelete(oControlEvent)The event is fired, when user deletes the attached file.
attachmentSelect(oControlEvent)The event is fired when the value of attached file has been changed.
attachmentUploadComplete(oControlEvent)Fire event uploadComplete to attached listeners.
deleteCard(oControlEvent)The event is fired when a new card is deleted if no data binding is available.
editCard(oControlEvent)The event is fired when a new card has been edited.
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.NoteTaker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.NoteTaker with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.NoteTaker.getMetadata()Returns a metadata object for class sap.suite.ui.commons.NoteTaker.
attachAddCard(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'addCard' event of this sap.suite.ui.commons.NoteTaker.
attachAttachmentClick(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentClick' event of this sap.suite.ui.commons.NoteTaker.
attachAttachmentDelete(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTaker.
attachAttachmentSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTaker.
attachAttachmentUploadComplete(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTaker.
attachDeleteCard(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'deleteCard' event of this sap.suite.ui.commons.NoteTaker.
attachEditCard(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'editCard' event of this sap.suite.ui.commons.NoteTaker.
detachAddCard(fnFunction, oListener)Detach event handler fnFunction from the 'addCard' event of this sap.suite.ui.commons.NoteTaker.
detachAttachmentClick(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentClick' event of this sap.suite.ui.commons.NoteTaker.
detachAttachmentDelete(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentDelete' event of this sap.suite.ui.commons.NoteTaker.
detachAttachmentSelect(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentSelect' event of this sap.suite.ui.commons.NoteTaker.
detachAttachmentUploadComplete(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentUploadComplete' event of this sap.suite.ui.commons.NoteTaker.
detachDeleteCard(fnFunction, oListener)Detach event handler fnFunction from the 'deleteCard' event of this sap.suite.ui.commons.NoteTaker.
detachEditCard(fnFunction, oListener)Detach event handler fnFunction from the 'editCard' event of this sap.suite.ui.commons.NoteTaker.
fireAddCard(mArguments?)Fire event addCard 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.
fireDeleteCard(mArguments?)Fire event deleteCard to attached listeners.
fireEditCard(mArguments?)Fire event editCard to attached listeners.
getAllTags()Returns tags from all cards in the control.
getAttachmentName()Getter for property attachmentName.
getAttachmentUploadUrl()Getter for property attachmentUploadUrl.
getCardViewAllTrigger()Getter for property cardViewAllTrigger.
getFilterCriteria()Getter for property filterCriteria.
getVisibleNotes()Getter for property visibleNotes.
handleAttachmentUploadFail()Must be called when the file upload to the server fail and it is needed to remove the attachment panel from the Feeder card.
setAttachmentData(sAdditionalData)Additional data that is sent to the back end service.
setAttachmentName(sAttachmentName)Setter for property attachmentName.
setAttachmentUploadUrl(sAttachmentUploadUrl)Setter for property attachmentUploadUrl.
setCardViewAllTrigger(iCardViewAllTrigger)Setter for property cardViewAllTrigger.
setFilterCriteria(oFilterCriteria)Setter for property filterCriteria.
setNextCardAttachmentUrl(sSUrl)Sets a URL for downloading the attachment.
setNextCardUid(sSUid)Sets an unique ID of the next card.
setVisibleNotes(iVisibleNotes)Setter for property visibleNotes.
uploadAttachment()Uploads the attached file to the server.
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, 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, 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.NoteTaker(sId?, mSettings?)
Constructor for a new NoteTaker.

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
    • cards : sap.suite.ui.commons.NoteTakerCard[]
  • Associations
    • Events
      • addCard : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • deleteCard : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
      • editCard : 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
    addCard(oControlEvent)
    The event is fired when a new card is added if no data binding is available. If data binding is available, the event is fired to notify a developer to add an element to the model.
    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.
    {int}oControlEvent.getParameters.viewAllTrigger The View All link appears in the Note Taker card when length of a body text exceeds the specified value.
    {boolean}oControlEvent.getParameters.thumbUp Indicates positive information for a new card.
    {boolean}oControlEvent.getParameters.thumbDown Indicates negative information for a new card.
    {string}oControlEvent.getParameters.attachmentFilename Stores the name of the file attached to the card.
    {string}oControlEvent.getParameters.uid The unique ID if available.
    {string}oControlEvent.getParameters.attachmentUrl Stores the URL of the file attached to the card.
    {sap.suite.ui.commons.NoteTakerCard}oControlEvent.getParameters.card A newly created card if no data binding is available. If data binding is available, this parameter is empty.
    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.uid The unique ID of the card.
    {string}oControlEvent.getParameters.isCardAttachment If true, a user chooses the attachment in the Note card. If false, a user chooses the attachment in the Feeder card.
    {string}oControlEvent.getParameters.filename A name of the attached file.
    attachmentDelete(oControlEvent)
    The event is fired, when user deletes the attached file.
    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.
    {string}oControlEvent.getParameters.uid The unique ID of the card.
    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)
    Fire event uploadComplete to attached listeners.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {string}oControlEvent.getParameters.response The response message of the String type 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.
    {string}oControlEvent.getParameters.uid The unique ID of the card.
    deleteCard(oControlEvent)
    The event is fired when a new card is deleted if no data binding is available. If data binding is available, the event is fired to notify a developer to delete the element from the model.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {string}oControlEvent.getParameters.title The title of the card to be deleted.
    {string}oControlEvent.getParameters.body The text of the card to be deleted.
    {string}oControlEvent.getParameters.timestamp The timestamp of the card to be deleted.
    {string}oControlEvent.getParameters.uid The unique ID that was set by an application developer.
    {boolean}oControlEvent.getParameters.thumbUp Indicates positive information for the deleted card.
    {boolean}oControlEvent.getParameters.thumbDown Indicates negative information for the deleted card.
    editCard(oControlEvent)
    The event is fired when a new card has been edited.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    {string}oControlEvent.getParameters.title The title of the edited card.
    {string}oControlEvent.getParameters.body A new text of the edited card.
    {string}oControlEvent.getParameters.timestamp A new timestamp of the edited card.
    {string}oControlEvent.getParameters.uid A unique ID that was set by an application developer.
    {boolean}oControlEvent.getParameters.thumbUp Indicates positive information for the edited card.
    {boolean}oControlEvent.getParameters.thumbDown Indicates negative information for the edited card.
    {object}oControlEvent.getParameters.tags Updated array of the String type tags applied to the card during editing.
    Method Detail
    sap.suite.ui.commons.NoteTaker.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.suite.ui.commons.NoteTaker 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.NoteTaker.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.suite.ui.commons.NoteTaker.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    attachAddCard(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTaker
    Attach event handler fnFunction to the 'addCard' event of this sap.suite.ui.commons.NoteTaker.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTaker.
    itself.

    The event is fired when a new card is added if no data binding is available. If data binding is available, the event is fired to notify a developer to add an element to the model.

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

    The event is fired, when user deletes the attached file.

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

    Fire event uploadComplete to attached listeners.

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

    The event is fired when a new card is deleted if no data binding is available. If data binding is available, the event is fired to notify a developer to delete the element from the model.

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

    The event is fired when a new card has been edited.

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

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

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

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

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

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

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

    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.NoteTaker}this to allow method chaining
    fireAddCard(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event addCard 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.
    • 'viewAllTrigger' of type int The View All link appears in the Note Taker card when length of a body text exceeds the specified value.
    • 'thumbUp' of type boolean Indicates positive information for a new card.
    • 'thumbDown' of type boolean Indicates negative information for a new card.
    • 'attachmentFilename' of type string Stores the name of the file attached to the card.
    • 'uid' of type string The unique ID if available.
    • 'attachmentUrl' of type string Stores the URL of the file attached to the card.
    • 'card' of type sap.suite.ui.commons.NoteTakerCard A newly created card if no data binding is available. If data binding is available, this parameter is empty.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    fireAttachmentClick(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event attachmentClick to attached listeners.

    Expects following event parameters:

    • 'uid' of type string The unique ID of the card.
    • 'isCardAttachment' of type string If true, a user chooses the attachment in the Note card. If false, a user chooses the attachment in the Feeder card.
    • '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.NoteTaker}this to allow method chaining
    fireAttachmentDelete(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event attachmentDelete to attached listeners.

    Expects following event parameters:

    • 'filename' of type string A name of the attached file.
    • 'uid' of type string The unique ID of the card.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    fireAttachmentSelect(mArguments?): sap.suite.ui.commons.NoteTaker
    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.NoteTaker}this to allow method chaining
    fireAttachmentUploadComplete(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event attachmentUploadComplete to attached listeners.

    Expects following event parameters:

    • 'response' of type string The response message of the String type 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.
    • 'uid' of type string The unique ID of the card.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    fireDeleteCard(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event deleteCard to attached listeners.

    Expects following event parameters:

    • 'title' of type string The title of the card to be deleted.
    • 'body' of type string The text of the card to be deleted.
    • 'timestamp' of type string The timestamp of the card to be deleted.
    • 'uid' of type string The unique ID that was set by an application developer.
    • 'thumbUp' of type boolean Indicates positive information for the deleted card.
    • 'thumbDown' of type boolean Indicates negative information for the deleted card.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    fireEditCard(mArguments?): sap.suite.ui.commons.NoteTaker
    Fire event editCard to attached listeners.

    Expects following event parameters:

    • 'title' of type string The title of the edited card.
    • 'body' of type string A new text of the edited card.
    • 'timestamp' of type string A new timestamp of the edited card.
    • 'uid' of type string A unique ID that was set by an application developer.
    • 'thumbUp' of type boolean Indicates positive information for the edited card.
    • 'thumbDown' of type boolean Indicates negative information for the edited card.
    • 'tags' of type object Updated array of the String type tags applied to the card during editing.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    getAllTags(): object
    Returns tags from all cards in the control.
    Returns:
    {object}
    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. Defines a path on the server where the attached files are uploaded.

    Default value is empty/undefined

    Returns:
    {string} the value of property attachmentUploadUrl
    getCardViewAllTrigger(): int
    Getter for property cardViewAllTrigger. The View All link appears in the Note Taker card when length of a card body text exceeds the specified value. The updated value of this property is not applied to the existing cards.

    Default value is 1800

    Returns:
    {int} the value of property cardViewAllTrigger
    getFilterCriteria(): object
    Getter for property filterCriteria. A composite object containing criteria for filtering cards in the Note Taker.

    Default value is empty/undefined

    Returns:
    {object} the value of property filterCriteria
    getVisibleNotes(): int
    Getter for property visibleNotes. Number of notes to display.

    Default value is 2

    Returns:
    {int} the value of property visibleNotes
    handleAttachmentUploadFail(): sap.suite.ui.commons.NoteTaker
    Must be called when the file upload to the server fail and it is needed to remove the attachment panel from the Feeder card.
    Returns:
    {sap.suite.ui.commons.NoteTaker}
    setAttachmentData(sAdditionalData): sap.suite.ui.commons.NoteTaker
    Additional data that is sent to the back end service. Data will be transmitted as a value of a hidden input where the name is derived from the name property with suffix -data. Exposed from the FileUploader control.
    Parameters:
    {string}sAdditionalData Actual additional data.
    Returns:
    {sap.suite.ui.commons.NoteTaker}
    setAttachmentName(sAttachmentName): sap.suite.ui.commons.NoteTaker
    Setter for property attachmentName.

    Default value is attachment

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

    Default value is empty/undefined

    Parameters:
    {string}sAttachmentUploadUrl new value for property attachmentUploadUrl
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    setCardViewAllTrigger(iCardViewAllTrigger): sap.suite.ui.commons.NoteTaker
    Setter for property cardViewAllTrigger.

    Default value is 1800

    Parameters:
    {int}iCardViewAllTrigger new value for property cardViewAllTrigger
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    setFilterCriteria(oFilterCriteria): sap.suite.ui.commons.NoteTaker
    Setter for property filterCriteria.

    Default value is empty/undefined

    Parameters:
    {object}oFilterCriteria new value for property filterCriteria
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    setNextCardAttachmentUrl(sSUrl): sap.suite.ui.commons.NoteTaker
    Sets a URL for downloading the attachment. It must be called in the attachmentUploadComplete event handler.
    Parameters:
    {string}sSUrl The download URL of attachment for a card that will be added when a user chooses the Add button.
    Returns:
    {sap.suite.ui.commons.NoteTaker}
    setNextCardUid(sSUid): sap.suite.ui.commons.NoteTaker
    Sets an unique ID of the next card.
    Parameters:
    {string}sSUid
    Returns:
    {sap.suite.ui.commons.NoteTaker}
    setVisibleNotes(iVisibleNotes): sap.suite.ui.commons.NoteTaker
    Setter for property visibleNotes.

    Default value is 2

    Parameters:
    {int}iVisibleNotes new value for property visibleNotes
    Returns:
    {sap.suite.ui.commons.NoteTaker}this to allow method chaining
    uploadAttachment(): void
    Uploads the attached file to the server. Exposed from the FileUploader control.