Class sap.suite.ui.commons.NoteTakerCardModule: sap/suite/ui/commons/NoteTakerCard

extends Control

This control allows you to store Note Taker card header and body text.

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

Constructor Summary
new sap.suite.ui.commons.NoteTakerCard(sId?, mSettings?)Constructor for a new NoteTakerCard.
Event Summary
attachmentClick(oControlEvent)The event is fired when a user chooses the attachment download link.
deleteNote(oControlEvent)The event is fired when a card needs to be deleted.
editNote(oControlEvent)The event is fired when a user chooses the Edit button in the note card.
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.NoteTakerCard.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.NoteTakerCard with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.NoteTakerCard.getMetadata()Returns a metadata object for class sap.suite.ui.commons.NoteTakerCard.
attachAttachmentClick(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerCard.
attachDeleteNote(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'deleteNote' event of this sap.suite.ui.commons.NoteTakerCard.
attachEditNote(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'editNote' event of this sap.suite.ui.commons.NoteTakerCard.
detachAttachmentClick(fnFunction, oListener)Detach event handler fnFunction from the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerCard.
detachDeleteNote(fnFunction, oListener)Detach event handler fnFunction from the 'deleteNote' event of this sap.suite.ui.commons.NoteTakerCard.
detachEditNote(fnFunction, oListener)Detach event handler fnFunction from the 'editNote' event of this sap.suite.ui.commons.NoteTakerCard.
fireAttachmentClick(mArguments?)Fire event attachmentClick to attached listeners.
fireDeleteNote(mArguments?)Fire event deleteNote to attached listeners.
fireEditNote(mArguments?)Fire event editNote to attached listeners.
getAllTags()Getter for property allTags.
getAttachmentFilename()Getter for property attachmentFilename.
getAttachmentUrl()Getter for property attachmentUrl.
getBody()Getter for property body.
getHeader()Getter for property header.
getIsFiltered()Getter for property isFiltered.
getTags()Getter for property tags.
getThumbDown()Getter for property thumbDown.
getThumbUp()Getter for property thumbUp.
getTimestamp()Getter for property timestamp.
getUid()Getter for property uid.
getViewAllTrigger()Getter for property viewAllTrigger.
setAllTags(oAllTags)Setter for property allTags.
setAttachmentFilename(sAttachmentFilename)Setter for property attachmentFilename.
setAttachmentUrl(sAttachmentUrl)Setter for property attachmentUrl.
setBody(sBody)Setter for property body.
setHeader(sHeader)Setter for property header.
setIsFiltered(bIsFiltered)Setter for property isFiltered.
setTags(oTags)Setter for property tags.
setThumbDown(bThumbDown)Setter for property thumbDown.
setThumbUp(bThumbUp)Setter for property thumbUp.
setTimestamp(oTimestamp)Setter for property timestamp.
setUid(sUid)Setter for property uid.
setViewAllTrigger(iViewAllTrigger)Setter for property viewAllTrigger.
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.NoteTakerCard(sId?, mSettings?)
Constructor for a new NoteTakerCard.

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
        • editNote : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
        • deleteNote : 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
      attachmentClick(oControlEvent)
      The event is fired when a user chooses the attachment download link.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.uid A unique ID that was set by an application developer.
      {string}oControlEvent.getParameters.url The address of the file attached to the card.
      {string}oControlEvent.getParameters.filename The name of the file attached to the card.
      deleteNote(oControlEvent)
      The event is fired when a card needs to be deleted. This event is needed for the Note Taker control.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.cardId The HTML ID of a card that needs to be deleted.
      {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 A 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.
      editNote(oControlEvent)
      The event is fired when a user chooses the Edit button in the note card.
      Parameters:
      {sap.ui.base.Event}oControlEvent
      {sap.ui.base.EventProvider}oControlEvent.getSource
      {object}oControlEvent.getParameters
      {string}oControlEvent.getParameters.title The title of 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.NoteTakerCard.extend(sClassName, oClassInfo?, FNMetaImpl?): function
      Creates a new subclass of class sap.suite.ui.commons.NoteTakerCard 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.NoteTakerCard.getMetadata(): sap.ui.base.Metadata
      Returns a metadata object for class sap.suite.ui.commons.NoteTakerCard.
      Returns:
      {sap.ui.base.Metadata} Metadata object describing this class
      attachAttachmentClick(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerCard
      Attach event handler fnFunction to the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerCard.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerCard.
      itself.

      The event is fired when a user chooses the attachment download 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.NoteTakerCard.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      attachDeleteNote(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerCard
      Attach event handler fnFunction to the 'deleteNote' event of this sap.suite.ui.commons.NoteTakerCard.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerCard.
      itself.

      The event is fired when a card needs to be deleted. This event is needed for the Note Taker 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.NoteTakerCard.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      attachEditNote(oData?, fnFunction, oListener?): sap.suite.ui.commons.NoteTakerCard
      Attach event handler fnFunction to the 'editNote' event of this sap.suite.ui.commons.NoteTakerCard.
      . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.suite.ui.commons.NoteTakerCard.
      itself.

      The event is fired when a user chooses the Edit button in the note 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.NoteTakerCard.
      itself.
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      detachAttachmentClick(fnFunction, oListener): sap.suite.ui.commons.NoteTakerCard
      Detach event handler fnFunction from the 'attachmentClick' event of this sap.suite.ui.commons.NoteTakerCard.

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

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

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

      Expects following event parameters:

      • 'uid' of type string A unique ID that was set by an application developer.
      • 'url' of type string The address of the file attached to the card.
      • 'filename' of type string The name of the file attached to the card.
      Parameters:
      {Map}mArguments? the arguments to pass along with the event.
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      fireDeleteNote(mArguments?): sap.suite.ui.commons.NoteTakerCard
      Fire event deleteNote to attached listeners.

      Expects following event parameters:

      • 'cardId' of type string The HTML ID of a card that needs to be deleted.
      • '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 A 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.NoteTakerCard}this to allow method chaining
      fireEditNote(mArguments?): sap.suite.ui.commons.NoteTakerCard
      Fire event editNote to attached listeners.

      Expects following event parameters:

      • 'title' of type string The title of 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.NoteTakerCard}this to allow method chaining
      getAllTags(): object
      Getter for property allTags. Contains an array of the String type tags available for selection during the card update.

      Default value is []

      Returns:
      {object} the value of property allTags
      getAttachmentFilename(): string
      Getter for property attachmentFilename. Stores the name of the file attached to the card.

      Default value is empty/undefined

      Returns:
      {string} the value of property attachmentFilename
      getAttachmentUrl(): string
      Getter for property attachmentUrl. Stores the address of the file attached to the card.

      Default value is empty/undefined

      Returns:
      {string} the value of property attachmentUrl
      getBody(): string
      Getter for property body. Stores the Note Taker card body text.

      Default value is empty/undefined

      Returns:
      {string} the value of property body
      getHeader(): string
      Getter for property header. Stores the Note Taker card header.

      Default value is empty/undefined

      Returns:
      {string} the value of property header
      getIsFiltered(): boolean
      Getter for property isFiltered. Shows whether the note card is hidden by the applied filter.

      Default value is false

      Returns:
      {boolean} the value of property isFiltered
      getTags(): object
      Getter for property tags. Contains an array of the String type tags applied to the current card.

      Default value is []

      Returns:
      {object} the value of property tags
      getThumbDown(): boolean
      Getter for property thumbDown. Indicates negative information for the card.

      Default value is empty/undefined

      Returns:
      {boolean} the value of property thumbDown
      getThumbUp(): boolean
      Getter for property thumbUp. Indicates positive information for the card.

      Default value is empty/undefined

      Returns:
      {boolean} the value of property thumbUp
      getTimestamp(): object
      Getter for property timestamp. Stores a timestamp of the Note Taker card.

      Default value is new Date()

      Returns:
      {object} the value of property timestamp
      getUid(): string
      Getter for property uid. The card ID. This property should be set by an application developer.

      Default value is empty/undefined

      Returns:
      {string} the value of property uid
      getViewAllTrigger(): int
      Getter for property viewAllTrigger. The View All link appears in the Note Taker card if a body text length exceeds the specified value.

      Default value is 1800

      Returns:
      {int} the value of property viewAllTrigger
      setAllTags(oAllTags): sap.suite.ui.commons.NoteTakerCard
      Setter for property allTags.

      Default value is []

      Parameters:
      {object}oAllTags new value for property allTags
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setAttachmentFilename(sAttachmentFilename): sap.suite.ui.commons.NoteTakerCard
      Setter for property attachmentFilename.

      Default value is empty/undefined

      Parameters:
      {string}sAttachmentFilename new value for property attachmentFilename
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setAttachmentUrl(sAttachmentUrl): sap.suite.ui.commons.NoteTakerCard
      Setter for property attachmentUrl.

      Default value is empty/undefined

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

      Default value is empty/undefined

      Parameters:
      {string}sBody new value for property body
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setHeader(sHeader): sap.suite.ui.commons.NoteTakerCard
      Setter for property header.

      Default value is empty/undefined

      Parameters:
      {string}sHeader new value for property header
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setIsFiltered(bIsFiltered): sap.suite.ui.commons.NoteTakerCard
      Setter for property isFiltered.

      Default value is false

      Parameters:
      {boolean}bIsFiltered new value for property isFiltered
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setTags(oTags): sap.suite.ui.commons.NoteTakerCard
      Setter for property tags.

      Default value is []

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

      Default value is empty/undefined

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

      Default value is empty/undefined

      Parameters:
      {boolean}bThumbUp new value for property thumbUp
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setTimestamp(oTimestamp): sap.suite.ui.commons.NoteTakerCard
      Setter for property timestamp.

      Default value is new Date()

      Parameters:
      {object}oTimestamp new value for property timestamp
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setUid(sUid): sap.suite.ui.commons.NoteTakerCard
      Setter for property uid.

      Default value is empty/undefined

      Parameters:
      {string}sUid new value for property uid
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining
      setViewAllTrigger(iViewAllTrigger): sap.suite.ui.commons.NoteTakerCard
      Setter for property viewAllTrigger.

      Default value is 1800

      Parameters:
      {int}iViewAllTrigger new value for property viewAllTrigger
      Returns:
      {sap.suite.ui.commons.NoteTakerCard}this to allow method chaining