abstract class sap.ui.mdc.valuehelp.base.DialogTab

Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/mdc/valuehelp/base/DialogTab
Application Component: CA-UI5-MDC

Content for the sap.ui.mdc.valuehelp.content.Dialog element.


Constructor

Constructor for a new DialogTab.

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.mdc.valuehelp.base.DialogTab(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new control, generated automatically if no ID is given

mSettings? object

Initial settings for the new control


Properties

Name Type Default Value Description
content object

Content control

Visibility: public

Events Overview

Event Description
cancel

Fired if the change is cancelled.

confirm

Fired if a change on the content is confirmed

select

Fired if the selected condition changed.

cancel

Fired if the change is cancelled.

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

confirm

Fired if a change on the content is confirmed

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

True if the value help need to be closed

select

Fired if the selected condition changed.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
type sap.ui.mdc.enum.SelectType

Type of the selection change (add, remove)

conditions object[]

Changed conditions

Note: A condition must have the structure of ConditionObject.


Methods Overview

Method Description
attachCancel

Attaches event handler fnFunction to the cancel event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if the change is cancelled.

attachConfirm

Attaches event handler fnFunction to the confirm event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if a change on the content is confirmed

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if the selected condition changed.

detachCancel

Detaches event handler fnFunction from the cancel event of this sap.ui.mdc.valuehelp.base.DialogTab.

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

detachConfirm

Detaches event handler fnFunction from the confirm event of this sap.ui.mdc.valuehelp.base.DialogTab.

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

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.valuehelp.base.DialogTab.

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

sap.ui.mdc.valuehelp.base.DialogTab.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.base.DialogTab 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.Control.extend.

fireCancel

Fires event cancel to attached listeners.

fireConfirm

Fires event confirm to attached listeners.

fireSelect

Fires event select to attached listeners.

getContent

Gets current value of property content.

Content control

sap.ui.mdc.valuehelp.base.DialogTab.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.base.DialogTab.

setContent

Sets a new value for property content.

Content control

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

attachCancel

Attaches event handler fnFunction to the cancel event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if the change is cancelled.

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.mdc.valuehelp.base.DialogTab itself

attachConfirm

Attaches event handler fnFunction to the confirm event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if a change on the content is confirmed

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.mdc.valuehelp.base.DialogTab itself

attachSelect

Attaches event handler fnFunction to the select event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab itself.

Fired if the selected condition changed.

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.mdc.valuehelp.base.DialogTab itself

detachCancel

Detaches event handler fnFunction from the cancel event of this sap.ui.mdc.valuehelp.base.DialogTab.

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

detachConfirm

Detaches event handler fnFunction from the confirm event of this sap.ui.mdc.valuehelp.base.DialogTab.

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

detachSelect

Detaches event handler fnFunction from the select event of this sap.ui.mdc.valuehelp.base.DialogTab.

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.mdc.valuehelp.base.DialogTab.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.base.DialogTab 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.Control.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

fireCancel

Fires event cancel to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

fireConfirm

Fires event confirm to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

close boolean

True if the value help need to be closed

fireSelect

Fires event select to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

type sap.ui.mdc.enum.SelectType

Type of the selection change (add, remove)

conditions object[]

Changed conditions

Note: A condition must have the structure of ConditionObject.

getContent

Gets current value of property content.

Content control

sap.ui.mdc.valuehelp.base.DialogTab.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.base.DialogTab.

setContent

Sets a new value for property content.

Content control

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

Param Type DefaultValue Description
oContent object

New value for property content