Class sap.uiext.inbox.composite.InboxTaskCommentsModule: sap/uiext/inbox/composite/InboxTaskComments

extends Control

InboxTaskComments

Constructor Summary
new sap.uiext.inbox.composite.InboxTaskComments(sId?, mSettings?)Constructor for a new composite/InboxTaskComments.
Event Summary
commentSubmit(oControlEvent)Event is raised when submit on the feeder is pressed.
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.uiext.inbox.composite.InboxTaskComments.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uiext.inbox.composite.InboxTaskComments with name sClassName and enriches it with the information contained in oClassInfo.
sap.uiext.inbox.composite.InboxTaskComments.getMetadata()Returns a metadata object for class sap.uiext.inbox.composite.InboxTaskComments.
addComment(oComment)Adds some comment oComment to the aggregation named comments.
attachCommentSubmit(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'commentSubmit' event of this sap.uiext.inbox.composite.InboxTaskComments.
destroyComments()Destroys all the comments in the aggregation named comments.
detachCommentSubmit(fnFunction, oListener)Detach event handler fnFunction from the 'commentSubmit' event of this sap.uiext.inbox.composite.InboxTaskComments.
fireCommentSubmit(mArguments?)Fire event commentSubmit to attached listeners.
getComments()Getter for aggregation comments.
getFeederSender()Getter for property feederSender.
getFeederThumbnailSrc()Getter for property feederThumbnailSrc.
getShowFeeder()Getter for property showFeeder.
getShowHeader()Getter for property showHeader.
indexOfComment(oComment)Checks for the provided sap.uiext.inbox.composite.InboxComment in the aggregation named comments and returns its index if found or -1 otherwise.
insertComment(oComment, iIndex)Inserts a comment into the aggregation named comments.
removeAllComments()Removes all the controls in the aggregation named comments.
removeComment(vComment)Removes an comment from the aggregation named comments.
setFeederSender(sFeederSender)Setter for property feederSender.
setFeederThumbnailSrc(sFeederThumbnailSrc)Setter for property feederThumbnailSrc.
setShowFeeder(bShowFeeder)Setter for property showFeeder.
setShowHeader(bShowHeader)Setter for property showHeader.
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, 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, 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.uiext.inbox.composite.InboxTaskComments(sId?, mSettings?)
Constructor for a new composite/InboxTaskComments.

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:

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
commentSubmit(oControlEvent)
Event is raised when submit on the feeder is pressed.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.uiext.inbox.composite.InboxTaskComments.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uiext.inbox.composite.InboxTaskComments 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.uiext.inbox.composite.InboxTaskComments.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uiext.inbox.composite.InboxTaskComments.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addComment(oComment): sap.uiext.inbox.composite.InboxTaskComments
Adds some comment oComment to the aggregation named comments.
Parameters:
{sap.uiext.inbox.composite.InboxComment}oComment the comment to add; if empty, nothing is inserted
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
attachCommentSubmit(oData?, fnFunction, oListener?): sap.uiext.inbox.composite.InboxTaskComments
Attach event handler fnFunction to the 'commentSubmit' event of this sap.uiext.inbox.composite.InboxTaskComments.
. When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.uiext.inbox.composite.InboxTaskComments.
itself.

Event is raised when submit on the feeder is pressed.

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.uiext.inbox.composite.InboxTaskComments.
itself.
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
destroyComments(): sap.uiext.inbox.composite.InboxTaskComments
Destroys all the comments in the aggregation named comments.
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
detachCommentSubmit(fnFunction, oListener): sap.uiext.inbox.composite.InboxTaskComments
Detach event handler fnFunction from the 'commentSubmit' event of this sap.uiext.inbox.composite.InboxTaskComments.

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.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
fireCommentSubmit(mArguments?): sap.uiext.inbox.composite.InboxTaskComments
Fire event commentSubmit to attached listeners.
Parameters:
{Map}mArguments? the arguments to pass along with the event.
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
getComments(): sap.uiext.inbox.composite.InboxComment[]
Getter for aggregation comments.
URL to the thumbnail image.
Returns:
{sap.uiext.inbox.composite.InboxComment[]}
getFeederSender(): string
Getter for property feederSender. Sender for the comment feeder

Default value is empty/undefined

Returns:
{string} the value of property feederSender
getFeederThumbnailSrc(): sap.ui.core.URI
Getter for property feederThumbnailSrc. URL to the thumbnail image for the comment feeder.

Default value is empty/undefined

Returns:
{sap.ui.core.URI} the value of property feederThumbnailSrc
getShowFeeder(): boolean
Getter for property showFeeder. Boolean value for visibilty of comment feeder

Default value is true

Returns:
{boolean} the value of property showFeeder
getShowHeader(): boolean
Getter for property showHeader. Boolean value for visibility of header

Default value is false

Returns:
{boolean} the value of property showHeader
indexOfComment(oComment): int
Checks for the provided sap.uiext.inbox.composite.InboxComment in the aggregation named comments and returns its index if found or -1 otherwise.
Parameters:
{sap.uiext.inbox.composite.InboxComment}oComment the comment whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertComment(oComment, iIndex): sap.uiext.inbox.composite.InboxTaskComments
Inserts a comment into the aggregation named comments.
Parameters:
{sap.uiext.inbox.composite.InboxComment}oComment the comment to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the comment should be inserted at; for a negative value of iIndex, the comment is inserted at position 0; for a value greater than the current size of the aggregation, the comment is inserted at the last position
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
removeAllComments(): sap.uiext.inbox.composite.InboxComment[]
Removes all the controls in the aggregation named comments.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.uiext.inbox.composite.InboxComment[]} an array of the removed elements (might be empty)
removeComment(vComment): sap.uiext.inbox.composite.InboxComment
Removes an comment from the aggregation named comments.
Parameters:
{int|string|sap.uiext.inbox.composite.InboxComment}vComment the comment to remove or its index or id
Returns:
{sap.uiext.inbox.composite.InboxComment} the removed comment or null
setFeederSender(sFeederSender): sap.uiext.inbox.composite.InboxTaskComments
Setter for property feederSender.

Default value is empty/undefined

Parameters:
{string}sFeederSender new value for property feederSender
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
setFeederThumbnailSrc(sFeederThumbnailSrc): sap.uiext.inbox.composite.InboxTaskComments
Setter for property feederThumbnailSrc.

Default value is empty/undefined

Parameters:
{sap.ui.core.URI}sFeederThumbnailSrc new value for property feederThumbnailSrc
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
setShowFeeder(bShowFeeder): sap.uiext.inbox.composite.InboxTaskComments
Setter for property showFeeder.

Default value is true

Parameters:
{boolean}bShowFeeder new value for property showFeeder
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining
setShowHeader(bShowHeader): sap.uiext.inbox.composite.InboxTaskComments
Setter for property showHeader.

Default value is false

Parameters:
{boolean}bShowHeader new value for property showHeader
Returns:
{sap.uiext.inbox.composite.InboxTaskComments}this to allow method chaining