Class sap.gantt.config.SettingItemModule: sap/gantt/config/SettingItem

extends Element

The SettingItem control allows you to create a setting item in the toolbar, which is presented as a checkbox with a label.

Constructor Summary
new sap.gantt.config.SettingItem(sId?, mSettings?)Creates and initializes a new setting item.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.gantt.config.SettingItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.SettingItem with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.config.SettingItem.getMetadata()Returns a metadata object for class sap.gantt.config.SettingItem.
getChecked()Gets current value of property checked.
getDisplayText()Gets current value of property displayText.
getKey()Gets current value of property key.
setChecked(bChecked)Sets a new value for property checked.
setDisplayText(sDisplayText)Sets a new value for property displayText.
setKey(sKey)Sets a new value for property key.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.gantt.config.SettingItem(sId?, mSettings?)
Creates and initializes a new setting item.

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

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? ID of the new control, generated automatically if no ID is given
{object}mSettings? Initial settings for the new control
Method Detail
sap.gantt.config.SettingItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.config.SettingItem 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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.gantt.config.SettingItem.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.config.SettingItem.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getChecked(): boolean
Gets current value of property checked.

Indicates whether the checkbox is selected or not

Default value is false.

Returns:
{boolean} Value of property checked
getDisplayText(): string
Gets current value of property displayText.

Aria label of the checkbox

Returns:
{string} Value of property displayText
getKey(): string
Gets current value of property key.

Identifier of an event when the checkbox is toggled

Returns:
{string} Value of property key
setChecked(bChecked): sap.gantt.config.SettingItem
Sets a new value for property checked.

Indicates whether the checkbox is selected or not

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

Default value is false.

Parameters:
{boolean}bChecked New value for property checked
Returns:
{sap.gantt.config.SettingItem} Reference to this in order to allow method chaining
setDisplayText(sDisplayText): sap.gantt.config.SettingItem
Sets a new value for property displayText.

Aria label of the checkbox

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

Parameters:
{string}sDisplayText New value for property displayText
Returns:
{sap.gantt.config.SettingItem} Reference to this in order to allow method chaining
setKey(sKey): sap.gantt.config.SettingItem
Sets a new value for property key.

Identifier of an event when the checkbox is toggled

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

Parameters:
{string}sKey New value for property key
Returns:
{sap.gantt.config.SettingItem} Reference to this in order to allow method chaining