class sap.ui.vk.RedlineConversation

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/RedlineConversation
Application Component: CA-UI5-VTK

Provides a base class control for RedlineConversations.


Constructor

Constructor for a new RedlineConversation.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.RedlineConversation()

Properties

Name Type Default Value Description
animationOffset float 0 Visibility: public
conversationName string Visibility: public
timestamp int Visibility: public
viewId string empty string Visibility: public
viewInfo any Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
comments 0..n sap.ui.vk.RedlineElementComment

Methods Overview

Method Description
addComment

Adds some comment to the aggregation comments.

destroyComments

Destroys all the comments in the aggregation comments.

sap.ui.vk.RedlineConversation.extend

Creates a new subclass of class sap.ui.vk.RedlineConversation with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

getAnimationOffset

Gets current value of property animationOffset.

Default value is 0.

getComments

Gets content of aggregation comments.

getConversationName

Gets current value of property conversationName.

sap.ui.vk.RedlineConversation.getMetadata

Returns a metadata object for class sap.ui.vk.RedlineConversation.

getTimestamp

Gets current value of property timestamp.

getViewId

Gets current value of property viewId.

Default value is empty string.

getViewInfo

Gets current value of property viewInfo.

indexOfComment

Checks for the provided sap.ui.vk.RedlineElementComment in the aggregation comments. and returns its index if found or -1 otherwise.

insertComment

Inserts a comment into the aggregation comments.

removeAllComments

Removes all the controls from the aggregation comments.

Additionally, it unregisters them from the hosting UIArea.

removeComment

Removes a comment from the aggregation comments.

setAnimationOffset

Sets a new value for property animationOffset.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.

setConversationName

Sets a new value for property conversationName.

When called with a value of null or undefined, the default value of the property will be restored.

setTimestamp

Sets a new value for property timestamp.

When called with a value of null or undefined, the default value of the property will be restored.

setViewId

Sets a new value for property viewId.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setViewInfo

Sets a new value for property viewInfo.

When called with a value of null or undefined, the default value of the property will be restored.

addComment

Adds some comment to the aggregation comments.

Param Type DefaultValue Description
oComment sap.ui.vk.RedlineElementComment

The comment to add; if empty, nothing is inserted

destroyComments

Destroys all the comments in the aggregation comments.

sap.ui.vk.RedlineConversation.extend

Creates a new subclass of class sap.ui.vk.RedlineConversation with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getAnimationOffset

Gets current value of property animationOffset.

Default value is 0.

getComments

Gets content of aggregation comments.

getConversationName

Gets current value of property conversationName.

sap.ui.vk.RedlineConversation.getMetadata

Returns a metadata object for class sap.ui.vk.RedlineConversation.

getTimestamp

Gets current value of property timestamp.

getViewId

Gets current value of property viewId.

Default value is empty string.

getViewInfo

Gets current value of property viewInfo.

indexOfComment

Checks for the provided sap.ui.vk.RedlineElementComment in the aggregation comments. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oComment sap.ui.vk.RedlineElementComment

The comment whose index is looked for

insertComment

Inserts a comment into the aggregation comments.

Param Type DefaultValue Description
oComment sap.ui.vk.RedlineElementComment

The comment to insert; if empty, nothing is inserted

iIndex int

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

removeAllComments

Removes all the controls from the aggregation comments.

Additionally, it unregisters them from the hosting UIArea.

removeComment

Removes a comment from the aggregation comments.

Param Type DefaultValue Description
vComment int string sap.ui.vk.RedlineElementComment

The comment to remove or its index or id

setAnimationOffset

Sets a new value for property animationOffset.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.

Param Type DefaultValue Description
fAnimationOffset float 0

New value for property animationOffset

setConversationName

Sets a new value for property conversationName.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sConversationName string

New value for property conversationName

setTimestamp

Sets a new value for property timestamp.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
iTimestamp int

New value for property timestamp

setViewId

Sets a new value for property viewId.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sViewId string ""

New value for property viewId

setViewInfo

Sets a new value for property viewInfo.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oViewInfo any

New value for property viewInfo