Mode

extends Element

The Mode control specifies the mode which is used in GanttChart and Shape. Mode enables GanttChart to show the same objects in different views.

Constructor Summary

new sap.gantt.config.Mode(sId?, mSettings?)Creates and initializes a new mode

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.gantt.config.Mode.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.Mode with name sClassName and enriches it with the information contained in oClassInfo.

sap.gantt.config.Mode.getMetadata()Returns a metadata object for class sap.gantt.config.Mode.

getActiveIcon()Gets current value of property activeIcon.

getIcon()Gets current value of property icon.

getKey()Gets current value of property key.

getText()Gets current value of property text.

setActiveIcon(sActiveIcon)Sets a new value for property activeIcon.

setIcon(sIcon)Sets a new value for property icon.

setKey(sKey)Sets a new value for property key.

setText(sText)Sets a new value for property text.

Methods borrowed from class sap.ui.core.Element

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.Mode(sId?, mSettings?)

Creates and initializes a new mode

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:

Properties
- key : string
- text : string
- icon : sap.ui.core.URI
- activeIcon : sap.ui.core.URI

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.Mode.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.gantt.config.Mode 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.Mode.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.gantt.config.Mode.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getActiveIcon(): sap.ui.core.URI

Gets current value of property activeIcon.

URL of the active icon of the mode

Returns:

{sap.ui.core.URI} Value of property activeIcon

getIcon(): sap.ui.core.URI

Gets current value of property icon.

URL of the icon of the mode

Returns:

{sap.ui.core.URI} Value of property icon

getKey(): string

Gets current value of property key.

Unique key of the mode

Returns:

{string} Value of property key

getText(): string

Gets current value of property text.

Description of the mode

Returns:

{string} Value of property text

setActiveIcon(sActiveIcon): sap.gantt.config.Mode

Sets a new value for property activeIcon.

URL of the active icon of the mode

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

Parameters:

{sap.ui.core.URI} sActiveIcon New value for property activeIcon

Returns:

{sap.gantt.config.Mode} Reference to this in order to allow method chaining

setIcon(sIcon): sap.gantt.config.Mode

Sets a new value for property icon.

URL of the icon of the mode

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

Parameters:

{sap.ui.core.URI} sIcon New value for property icon

Returns:

{sap.gantt.config.Mode} Reference to this in order to allow method chaining

setKey(sKey): sap.gantt.config.Mode

Sets a new value for property key.

Unique key of the mode

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.Mode} Reference to this in order to allow method chaining

setText(sText): sap.gantt.config.Mode

Sets a new value for property text.

Description of the mode

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

Parameters:

{string} sText New value for property text

Returns:

{sap.gantt.config.Mode} Reference to this in order to allow method chaining