abstract class sap.ui.mdc.field.DefineConditionPanel

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

A DefineConditionPanel control is used inside the ValueHelpPanel control to enter different types of conditions.


Constructor

Constructor for a new DefineConditionPanel.

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.field.DefineConditionPanel(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
conditions object[]

Sets the conditions that represent the selected values of the help.

Since: 1.62.0.

Visibility: public
formatOptions object empty object

The formatOptions for the ConditionType used to format tokens.

Since: 1.62.0.

Visibility: public
inputOK boolean true

If set, there has been no invalid user input.

Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel of the calling field help and automatically update it.

Since: 1.87.0.

Visibility: public
label string empty string

The label for the DefineConditionPanel used as panel headerText.

Since: 1.84.0.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_content 0..1 sap.ui.core.Control

Optional content that can be rendered.

Note: Bind the value-holding property of the control to '$field>/conditions' using sap.ui.mdc.field.ConditionsType as type.

If the control needs to show multiple conditions, bind its aggregation to '$field>/conditions'. Bind the item controls value-holding property using sap.ui.mdc.field.ConditionType as type.

Warning: Only controls allowed in a Form are allowed to be used for this optional content. Other controls might break the layout. This means the sap.ui.core.IFormContent interface needs to be implemented by these controls.


Events Overview

Event Description
conditionProcessed

Event is fired if the user processes a condition. (Not known if changed.)

conditionProcessed

Event is fired if the user processes a condition. (Not known if changed.)

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

Methods Overview

Method Description
attachConditionProcessed

Attaches event handler fnFunction to the conditionProcessed event of this sap.ui.mdc.field.DefineConditionPanel.

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.field.DefineConditionPanel itself.

Event is fired if the user processes a condition. (Not known if changed.)

detachConditionProcessed

Detaches event handler fnFunction from the conditionProcessed event of this sap.ui.mdc.field.DefineConditionPanel.

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

sap.ui.mdc.field.DefineConditionPanel.extend

Creates a new subclass of class sap.ui.mdc.field.DefineConditionPanel 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.

fireConditionProcessed

Fires event conditionProcessed to attached listeners.

getConditions

Gets current value of property conditions.

Sets the conditions that represent the selected values of the help.

Default value is [].

getFormatOptions

Gets current value of property formatOptions.

The formatOptions for the ConditionType used to format tokens.

Default value is {}.

getInputOK

Gets current value of property inputOK.

If set, there has been no invalid user input.

Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel of the calling field help and automatically update it.

Default value is true.

getLabel

Gets current value of property label.

The label for the DefineConditionPanel used as panel headerText.

Default value is empty string.

sap.ui.mdc.field.DefineConditionPanel.getMetadata

Returns a metadata object for class sap.ui.mdc.field.DefineConditionPanel.

setConditions

Sets a new value for property conditions.

Sets the conditions that represent the selected values of the help.

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

Default value is [].

setFormatOptions

Sets a new value for property formatOptions.

The formatOptions for the ConditionType used to format tokens.

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

Default value is {}.

setInputOK

Sets a new value for property inputOK.

If set, there has been no invalid user input.

Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel of the calling field help and automatically update it.

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

Default value is true.

setLabel

Sets a new value for property label.

The label for the DefineConditionPanel used as panel headerText.

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

Default value is empty string.

attachConditionProcessed

Attaches event handler fnFunction to the conditionProcessed event of this sap.ui.mdc.field.DefineConditionPanel.

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.field.DefineConditionPanel itself.

Event is fired if the user processes a condition. (Not known if 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.field.DefineConditionPanel itself

detachConditionProcessed

Detaches event handler fnFunction from the conditionProcessed event of this sap.ui.mdc.field.DefineConditionPanel.

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.field.DefineConditionPanel.extend

Creates a new subclass of class sap.ui.mdc.field.DefineConditionPanel 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

fireConditionProcessed

Fires event conditionProcessed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getConditions

Gets current value of property conditions.

Sets the conditions that represent the selected values of the help.

Default value is [].

getFormatOptions

Gets current value of property formatOptions.

The formatOptions for the ConditionType used to format tokens.

Default value is {}.

getInputOK

Gets current value of property inputOK.

If set, there has been no invalid user input.

Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel of the calling field help and automatically update it.

Default value is true.

getLabel

Gets current value of property label.

The label for the DefineConditionPanel used as panel headerText.

Default value is empty string.

sap.ui.mdc.field.DefineConditionPanel.getMetadata

Returns a metadata object for class sap.ui.mdc.field.DefineConditionPanel.

setConditions

Sets a new value for property conditions.

Sets the conditions that represent the selected values of the help.

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

Default value is [].

Param Type DefaultValue Description
sConditions object[] []

New value for property conditions

setFormatOptions

Sets a new value for property formatOptions.

The formatOptions for the ConditionType used to format tokens.

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

Default value is {}.

Param Type DefaultValue Description
oFormatOptions object {}

New value for property formatOptions

setInputOK

Sets a new value for property inputOK.

If set, there has been no invalid user input.

Note: This property must not be set from outside. It is a property because that way it can be bound to the ManagedObjectModel of the calling field help and automatically update it.

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

Default value is true.

Param Type DefaultValue Description
bInputOK boolean true

New value for property inputOK

setLabel

Sets a new value for property label.

The label for the DefineConditionPanel used as panel headerText.

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
sLabel string ""

New value for property label