HierarchyColumn

Defines the column attribute which is used in the hierarchy column

Constructor Summary

new sap.gantt.config.HierarchyColumn(sId?, mSettings?)Creates and initializes a new hierarchy column

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.HierarchyColumn.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.config.HierarchyColumn with name sClassName and enriches it with the information contained in oClassInfo.

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

getAttribute()Gets current value of property attribute.

getAttributes()Gets current value of property attributes.

getContentType()Gets current value of property contentType.

getFilterAttribute()Gets current value of property filterAttribute.

getKey()Gets current value of property key.

getSortAttribute()Gets current value of property sortAttribute.

getTitle()Gets current value of property title.

getWidth()Gets current value of property width.

setAttribute(sAttribute)Sets a new value for property attribute.

setAttributes(sAttributes)Sets a new value for property attributes.

setContentType(sContentType)Sets a new value for property contentType.

setFilterAttribute(sFilterAttribute)Sets a new value for property filterAttribute.

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

setSortAttribute(sSortAttribute)Sets a new value for property sortAttribute.

setTitle(sTitle)Sets a new value for property title.

setWidth(sWidth)Sets a new value for property width.

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

Creates and initializes a new hierarchy column

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
- title : string
- contentType : string
- sortAttribute : string
- filterAttribute : string
- attribute : string
- attributes : array (default: [])
- width : sap.ui.core.CSSSize

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getAttribute(): string

Gets current value of property attribute.

Attribute

Returns:

{string} Value of property attribute

getAttributes(): array

Gets current value of property attributes.

Attributes. Array of sap.gantt.config.ColumnAttribute

Default value is [].

Returns:

{array} Value of property attributes

getContentType(): string

Gets current value of property contentType.

Content type of the column

Returns:

{string} Value of property contentType

getFilterAttribute(): string

Gets current value of property filterAttribute.

Specifies the attribute by which the tree table filter items in the column

Returns:

{string} Value of property filterAttribute

getKey(): string

Gets current value of property key.

Unique key of the hierarchy column

Returns:

{string} Value of property key

getSortAttribute(): string

Gets current value of property sortAttribute.

Specifies the attribute by which the tree table sorts items in the column

Returns:

{string} Value of property sortAttribute

getTitle(): string

Gets current value of property title.

Title is used as the title of the column header in the tree table

Returns:

{string} Value of property title

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Column Width

Returns:

{sap.ui.core.CSSSize} Value of property width

setAttribute(sAttribute): sap.gantt.config.HierarchyColumn

Sets a new value for property attribute.

Attribute

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

Parameters:

{string} sAttribute New value for property attribute

Returns:

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

setAttributes(sAttributes): sap.gantt.config.HierarchyColumn

Sets a new value for property attributes.

Attributes. Array of sap.gantt.config.ColumnAttribute

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

Default value is [].

Parameters:

{array} sAttributes New value for property attributes

Returns:

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

setContentType(sContentType): sap.gantt.config.HierarchyColumn

Sets a new value for property contentType.

Content type of the column

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

Parameters:

{string} sContentType New value for property contentType

Returns:

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

setFilterAttribute(sFilterAttribute): sap.gantt.config.HierarchyColumn

Sets a new value for property filterAttribute.

Specifies the attribute by which the tree table filter items in the column

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

Parameters:

{string} sFilterAttribute New value for property filterAttribute

Returns:

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

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

Sets a new value for property key.

Unique key of the hierarchy column

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

setSortAttribute(sSortAttribute): sap.gantt.config.HierarchyColumn

Sets a new value for property sortAttribute.

Specifies the attribute by which the tree table sorts items in the column

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

Parameters:

{string} sSortAttribute New value for property sortAttribute

Returns:

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

setTitle(sTitle): sap.gantt.config.HierarchyColumn

Sets a new value for property title.

Title is used as the title of the column header in the tree table

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

Parameters:

{string} sTitle New value for property title

Returns:

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

setWidth(sWidth): sap.gantt.config.HierarchyColumn

Sets a new value for property width.

Column Width

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

Parameters:

{sap.ui.core.CSSSize} sWidth New value for property width

Returns:

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