class sap.ui.vk.RedlineCollaboration

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

Provides a base class control for RedlineCollaborations.


Constructor

Constructor for a new RedlineCollaboration.

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.RedlineCollaboration()

Aggregations

Default Aggregation:

Name Cardinality Type Description
conversations 0..n sap.ui.vk.RedlineConversation

A list of available conversations.


Associations

Name Cardinality Type Description
activeComment 0..1 sap.ui.vk.RedlineComment

Currently active comment.

activeConversation 0..1 sap.ui.vk.RedlineConversation

Currently active conversation.

viewport 0..1 sap.ui.vk.Viewport

Events Overview

Event Description
conversationActivated
conversationActivating
elementClicked
elementCreated
elementHovered

conversationActivated

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
conversation sap.ui.vk.RedlineConversation
viewportLocked boolean

conversationActivating

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
conversation sap.ui.vk.RedlineConversation

elementClicked

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
elementId string

elementCreated

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
element object

elementHovered

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
elementId string

Methods Overview

Method Description
addConversation

Adds some conversation to the aggregation conversations.

attachConversationActivated

Attaches event handler fnFunction to the conversationActivated event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

attachConversationActivating

Attaches event handler fnFunction to the conversationActivating event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

attachElementClicked

Attaches event handler fnFunction to the elementClicked event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

attachElementCreated

Attaches event handler fnFunction to the elementCreated event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

attachElementHovered

Attaches event handler fnFunction to the elementHovered event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

destroyConversations

Destroys all the conversations in the aggregation conversations.

detachConversationActivated

Detaches event handler fnFunction from the conversationActivated event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

detachConversationActivating

Detaches event handler fnFunction from the conversationActivating event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

detachElementClicked

Detaches event handler fnFunction from the elementClicked event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

detachElementCreated

Detaches event handler fnFunction from the elementCreated event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

detachElementHovered

Detaches event handler fnFunction from the elementHovered event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

sap.ui.vk.RedlineCollaboration.extend

Creates a new subclass of class sap.ui.vk.RedlineCollaboration 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.

fireConversationActivated

Fires event conversationActivated to attached listeners.

fireConversationActivating

Fires event conversationActivating to attached listeners.

fireElementClicked

Fires event elementClicked to attached listeners.

fireElementCreated

Fires event elementCreated to attached listeners.

fireElementHovered

Fires event elementHovered to attached listeners.

getActiveComment

ID of the element which is the current target of the association activeComment, or null.

getActiveConversation

ID of the element which is the current target of the association activeConversation, or null.

getConversations

Gets content of aggregation conversations.

A list of available conversations.

sap.ui.vk.RedlineCollaboration.getMetadata

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

getViewport

ID of the element which is the current target of the association viewport, or null.

indexOfConversation

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

insertConversation

Inserts a conversation into the aggregation conversations.

removeAllConversations

Removes all the controls from the aggregation conversations.

Additionally, it unregisters them from the hosting UIArea.

removeConversation

Removes a conversation from the aggregation conversations.

setActiveComment

Sets the associated activeComment.

addConversation

Adds some conversation to the aggregation conversations.

Param Type DefaultValue Description
oConversation sap.ui.vk.RedlineConversation

The conversation to add; if empty, nothing is inserted

attachConversationActivated

Attaches event handler fnFunction to the conversationActivated event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.RedlineCollaboration itself

attachConversationActivating

Attaches event handler fnFunction to the conversationActivating event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.RedlineCollaboration itself

attachElementClicked

Attaches event handler fnFunction to the elementClicked event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.RedlineCollaboration itself

attachElementCreated

Attaches event handler fnFunction to the elementCreated event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.RedlineCollaboration itself

attachElementHovered

Attaches event handler fnFunction to the elementHovered event of this sap.ui.vk.RedlineCollaboration.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.RedlineCollaboration itself.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.RedlineCollaboration itself

destroyConversations

Destroys all the conversations in the aggregation conversations.

detachConversationActivated

Detaches event handler fnFunction from the conversationActivated event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachConversationActivating

Detaches event handler fnFunction from the conversationActivating event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachElementClicked

Detaches event handler fnFunction from the elementClicked event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachElementCreated

Detaches event handler fnFunction from the elementCreated event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachElementHovered

Detaches event handler fnFunction from the elementHovered event of this sap.ui.vk.RedlineCollaboration.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vk.RedlineCollaboration.extend

Creates a new subclass of class sap.ui.vk.RedlineCollaboration 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

fireConversationActivated

Fires event conversationActivated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

conversation sap.ui.vk.RedlineConversation
viewportLocked boolean

fireConversationActivating

Fires event conversationActivating to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

conversation sap.ui.vk.RedlineConversation

fireElementClicked

Fires event elementClicked to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

elementId string

fireElementCreated

Fires event elementCreated to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

element object

fireElementHovered

Fires event elementHovered to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

elementId string

getActiveComment

ID of the element which is the current target of the association activeComment, or null.

getActiveConversation

ID of the element which is the current target of the association activeConversation, or null.

getConversations

Gets content of aggregation conversations.

A list of available conversations.

sap.ui.vk.RedlineCollaboration.getMetadata

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

getViewport

ID of the element which is the current target of the association viewport, or null.

indexOfConversation

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

Param Type DefaultValue Description
oConversation sap.ui.vk.RedlineConversation

The conversation whose index is looked for

insertConversation

Inserts a conversation into the aggregation conversations.

Param Type DefaultValue Description
oConversation sap.ui.vk.RedlineConversation

The conversation to insert; if empty, nothing is inserted

iIndex int

The 0-based index the conversation should be inserted at; for a negative value of iIndex, the conversation is inserted at position 0; for a value greater than the current size of the aggregation, the conversation is inserted at the last position

removeAllConversations

Removes all the controls from the aggregation conversations.

Additionally, it unregisters them from the hosting UIArea.

removeConversation

Removes a conversation from the aggregation conversations.

Param Type DefaultValue Description
vConversation int string sap.ui.vk.RedlineConversation

The conversation to remove or its index or id

setActiveComment

Sets the associated activeComment.

Param Type DefaultValue Description
oActiveComment sap.ui.core.ID sap.ui.vk.RedlineComment

ID of an element which becomes the new target of this activeComment association; alternatively, an element instance may be given