abstract class sap.ui.mdc.valuehelp.content.Bool

Visiblity: restricted
UX Guidelines:
Implements: sap.ui.mdc.valuehelp.ITypeaheadContent
Available since: N/A
Module: sap/ui/mdc/valuehelp/content/Bool
Application Component: CA-UI5-MDC

Content for the sap.ui.mdc.valuehelp.base.Container element to provide a value help for boolean fields.


Constructor

Constructor for a new Bool content.

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.

This class does not have its own settings, but all settings applicable to the base type sap.ui.mdc.valuehelp.content.FixedList can be used.

new sap.ui.mdc.valuehelp.content.Bool(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

Borrowed Properties

Name Type Default Value Description
filterList boolean true

If set, the items of the list are filtered based on filterValue.

If a type-ahead behavior for the connected field is wanted, this property must be set to true. For small lists all values are meant to be shown, independent of the typing in the connected field. In this case this property must be set to false.

If not set, the list opens if the user clicks into the connected field.

Visibility: public
groupable boolean false

If set, the items of the list can be grouped

Visibility: public
conditions object[]

Conditions of the value help

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
config object empty object

internal configuration

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
filterValue string empty string

Value for filtering ($search)

Note: This property must not be set from outside, it is only to be used by the corresponding container

Visibility: public
shortTitle string empty string

Title text that appears in the dialog header.

Visibility: public
title string empty string

Title text that appears tab header.

Visibility: public

Borrowed Aggregations

Name Cardinality Type Description
items 0..n sap.ui.mdc.field.ListFieldHelpItem

Items of the field help.

The key of the items is not shown in the list, but is used as a value of the connected field.

If the additionalText for all the items is not used, the column will not be displayed.

Note: At the moment, icons are not supported.

displayContent 0..1 sap.ui.core.Control

Content control that is put inside the parent container

Note: This aggregation must not be set from outside, it is only to be used by the corresponding container


Methods Overview

Method Description
addItem

Adds some item to the aggregation items.

Note: Do not add items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
destroyItems

Destroys all the items in the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
sap.ui.mdc.valuehelp.content.Bool.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.content.Bool 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.mdc.valuehelp.content.FixedList.extend.

sap.ui.mdc.valuehelp.content.Bool.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.content.Bool.

insertItem

Inserts a item to the aggregation items.

Note: Do not add items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
removeAllItems

Removes all the controls from the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
removeItem

Removes a item from the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
setCaseSensitive

Sets a new value for property caseSensitive.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
setFilterList

Sets a new value for property filterList.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
setUseAsValueHelp

Sets a new value for property useAsValueHelp.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
setUseFirstMatch

Sets a new value for property useFirstMatch.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.

addItem

Adds some item to the aggregation items.

Note: Do not add items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
Param Type DefaultValue Description
oItem sap.ui.mdc.field.ListFieldHelpItem

The item to add; if empty, nothing is inserted

destroyItems

Destroys all the items in the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.

sap.ui.mdc.valuehelp.content.Bool.extend

Creates a new subclass of class sap.ui.mdc.valuehelp.content.Bool 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.mdc.valuehelp.content.FixedList.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

sap.ui.mdc.valuehelp.content.Bool.getMetadata

Returns a metadata object for class sap.ui.mdc.valuehelp.content.Bool.

insertItem

Inserts a item to the aggregation items.

Note: Do not add items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
Param Type DefaultValue Description
oItem sap.ui.mdc.field.ListFieldHelpItem

The item to add; if empty, nothing is inserted

iIndex int

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

removeAllItems

Removes all the controls from the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.

removeItem

Removes a item from the aggregation items.

Note: Do not change items to the Bool content. The items will be filled by itself

Since Not supported, the items are automatically set.
Param Type DefaultValue Description
vItem int string sap.ui.mdc.field.ListFieldHelpItem

The item to remove or its index or id

setCaseSensitive

Sets a new value for property caseSensitive.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
Param Type DefaultValue Description
bCaseSensitive boolean false

New value for property caseSensitive

setFilterList

Sets a new value for property filterList.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
Param Type DefaultValue Description
bFilterList boolean false

New value for property filterList

setUseAsValueHelp

Sets a new value for property useAsValueHelp.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
Param Type DefaultValue Description
bUseAsValueHelp boolean true

New value for property useAsValueHelp

setUseFirstMatch

Sets a new value for property useFirstMatch.

Note: Do not set this property for the Bool content. It will be set by itself

Since Not supported, the property is automatically set.
Param Type DefaultValue Description
bUseFirstMatch boolean true

New value for property useFirstMatch