Class sap.gantt.config.HierarchyModule: sap/gantt/config/Hierarchy

extends Element

Defines the hierarchy in the Gantt chart. The hierarchy is used for building the tree table in sap.gantt.GanttChartWithTable.

Constructor Summary
new sap.gantt.config.Hierarchy(sId?, mSettings?)Creates and initializes a new hierarchy

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.Hierarchy.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.Hierarchy with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.config.Hierarchy.getMetadata()Returns a metadata object for class sap.gantt.config.Hierarchy.
getActiveModeKey()Gets current value of property activeModeKey.
getColumns()Gets current value of property columns.
getExpandedLevels()Gets current value of property expandedLevels.
getKey()Gets current value of property key.
getText()Gets current value of property text.
getToolbarSchemeKey()Gets current value of property toolbarSchemeKey.
setActiveModeKey(sActiveModeKey)Sets a new value for property activeModeKey.
setColumns(sColumns)Sets a new value for property columns.
setExpandedLevels(sExpandedLevels)Sets a new value for property expandedLevels.
setKey(sKey)Sets a new value for property key.
setText(sText)Sets a new value for property text.
setToolbarSchemeKey(sToolbarSchemeKey)Sets a new value for property toolbarSchemeKey.
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.Hierarchy(sId?, mSettings?)
Creates and initializes a new hierarchy

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 (default: sap.gantt.config.DEFAULT_HIERARCHY_KEY)
    • text : string (default: Default Hierarchy)
    • activeModeKey : string (default: sap.gantt.config.DEFAULT_MODE_KEY)
    • toolbarSchemeKey : string (default: sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY)
    • columns : array
    • expandedLevels : array

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.Hierarchy.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.config.Hierarchy 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.Hierarchy.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.config.Hierarchy.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getActiveModeKey(): string
Gets current value of property activeModeKey.

Key of sap.gantt.config.Mode

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Returns:
{string} Value of property activeModeKey
getColumns(): array
Gets current value of property columns.

Columns of the hierarchy. Array of sap.gantt.config.HierarchyColumn

Returns:
{array} Value of property columns
getExpandedLevels(): array
Gets current value of property expandedLevels.

expandedLevels determines how the tree table is initially expanded. This property is a two-dimensional array containing object types of row data. Only rows with data of the specified object types are expanded. Each child array represents a specific level in the hierarchy with the first child array representing the first level and so forth. For example, if this property is set to [["02", "03"], ["05"]], rows containing data of object types 02 or 03 in the first level and rows containing data of object type 05 in the second level are expanded.

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

Unique key of the hierarchy

Default value is sap.gantt.config.DEFAULT_HIERARCHY_KEY.

Returns:
{string} Value of property key
getText(): string
Gets current value of property text.

Description of the hierarchy

Default value is Default Hierarchy.

Returns:
{string} Value of property text
getToolbarSchemeKey(): string
Gets current value of property toolbarSchemeKey.

Key of sap.gantt.config.ToolbarScheme

Default value is sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY.

Returns:
{string} Value of property toolbarSchemeKey
setActiveModeKey(sActiveModeKey): sap.gantt.config.Hierarchy
Sets a new value for property activeModeKey.

Key of sap.gantt.config.Mode

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

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Parameters:
{string}sActiveModeKey New value for property activeModeKey
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining
setColumns(sColumns): sap.gantt.config.Hierarchy
Sets a new value for property columns.

Columns of the hierarchy. Array of sap.gantt.config.HierarchyColumn

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

Parameters:
{array}sColumns New value for property columns
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining
setExpandedLevels(sExpandedLevels): sap.gantt.config.Hierarchy
Sets a new value for property expandedLevels.

expandedLevels determines how the tree table is initially expanded. This property is a two-dimensional array containing object types of row data. Only rows with data of the specified object types are expanded. Each child array represents a specific level in the hierarchy with the first child array representing the first level and so forth. For example, if this property is set to [["02", "03"], ["05"]], rows containing data of object types 02 or 03 in the first level and rows containing data of object type 05 in the second level are expanded.

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

Parameters:
{array}sExpandedLevels New value for property expandedLevels
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining
setKey(sKey): sap.gantt.config.Hierarchy
Sets a new value for property key.

Unique key of the hierarchy

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

Default value is sap.gantt.config.DEFAULT_HIERARCHY_KEY.

Parameters:
{string}sKey New value for property key
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining
setText(sText): sap.gantt.config.Hierarchy
Sets a new value for property text.

Description of the hierarchy

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

Default value is Default Hierarchy.

Parameters:
{string}sText New value for property text
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining
setToolbarSchemeKey(sToolbarSchemeKey): sap.gantt.config.Hierarchy
Sets a new value for property toolbarSchemeKey.

Key of sap.gantt.config.ToolbarScheme

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

Default value is sap.gantt.config.DEFAULT_GANTTCHART_TOOLBAR_SCHEME_KEY.

Parameters:
{string}sToolbarSchemeKey New value for property toolbarSchemeKey
Returns:
{sap.gantt.config.Hierarchy} Reference to this in order to allow method chaining