ToolbarScheme

Defines the Toolbar scheme

Constructor Summary

new sap.gantt.config.ToolbarScheme(sId?, mSettings?)Creates and initializes a new toolbar scheme

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

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

getCustomToolbarItems()Gets current value of property customToolbarItems.

getExpandChart()Gets current value of property expandChart.

getExpandTree()Gets current value of property expandTree.

getKey()Gets current value of property key.

getLayout()Gets current value of property layout.

getLegend()Gets current value of property legend.

getMode()Gets current value of property mode.

getSettings()Gets current value of property settings.

getSourceSelect()Gets current value of property sourceSelect.

getTimeZoom()Gets current value of property timeZoom.

getToolbarDesign()Gets current value of property toolbarDesign.

setCustomToolbarItems(sCustomToolbarItems)Sets a new value for property customToolbarItems.

setExpandChart(sExpandChart)Sets a new value for property expandChart.

setExpandTree(sExpandTree)Sets a new value for property expandTree.

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

setLayout(sLayout)Sets a new value for property layout.

setLegend(sLegend)Sets a new value for property legend.

setMode(sMode)Sets a new value for property mode.

setSettings(sSettings)Sets a new value for property settings.

setSourceSelect(sSourceSelect)Sets a new value for property sourceSelect.

setTimeZoom(sTimeZoom)Sets a new value for property timeZoom.

setToolbarDesign(sToolbarDesign)Sets a new value for property toolbarDesign.

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

Creates and initializes a new toolbar scheme

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
- sourceSelect : sap.gantt.config.ToolbarGroup
- layout : sap.gantt.config.LayoutGroup
- customToolbarItems : sap.gantt.config.ToolbarGroup
- expandChart : sap.gantt.config.ExpandChartGroup
- expandTree : sap.gantt.config.ToolbarGroup
- timeZoom : sap.gantt.config.ToolbarGroup
- legend : sap.gantt.config.ToolbarGroup
- settings : sap.gantt.config.SettingGroup
- mode : sap.gantt.config.ModeGroup
- toolbarDesign : string (default: sap.m.ToolbarDesign.Auto)

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getCustomToolbarItems(): sap.gantt.config.ToolbarGroup

Gets current value of property customToolbarItems.

Toolbar group for custom toolbar items

Returns:

{sap.gantt.config.ToolbarGroup} Value of property customToolbarItems

getExpandChart(): sap.gantt.config.ExpandChartGroup

Gets current value of property expandChart.

Toolbar group for expanding a chart

Returns:

{sap.gantt.config.ExpandChartGroup} Value of property expandChart

getExpandTree(): sap.gantt.config.ToolbarGroup

Gets current value of property expandTree.

Toolbar group for expanding nodes of a tree table

Returns:

{sap.gantt.config.ToolbarGroup} Value of property expandTree

getKey(): string

Gets current value of property key.

Unique key of the toolbar scheme

Returns:

{string} Value of property key

getLayout(): sap.gantt.config.LayoutGroup

Gets current value of property layout.

Toolbar group for the Gantt chart layout

Returns:

{sap.gantt.config.LayoutGroup} Value of property layout

getLegend(): sap.gantt.config.ToolbarGroup

Gets current value of property legend.

Toolbar group for legend

Returns:

{sap.gantt.config.ToolbarGroup} Value of property legend

getMode(): sap.gantt.config.ModeGroup

Gets current value of property mode.

See sap.gantt.config.ModeGroup

Returns:

{sap.gantt.config.ModeGroup} Value of property mode

getSettings(): sap.gantt.config.SettingGroup

Gets current value of property settings.

See sap.gantt.config.SettingGroup

Returns:

{sap.gantt.config.SettingGroup} Value of property settings

getSourceSelect(): sap.gantt.config.ToolbarGroup

Gets current value of property sourceSelect.

Toolbar group for selecting a source

Returns:

{sap.gantt.config.ToolbarGroup} Value of property sourceSelect

getTimeZoom(): sap.gantt.config.ToolbarGroup

Gets current value of property timeZoom.

Toolbar group for the time zoom

Returns:

{sap.gantt.config.ToolbarGroup} Value of property timeZoom

getToolbarDesign(): string

Gets current value of property toolbarDesign.

Toolbar design. See sap.m.ToolbarDesign

Default value is sap.m.ToolbarDesign.Auto.

Returns:

{string} Value of property toolbarDesign

setCustomToolbarItems(sCustomToolbarItems): sap.gantt.config.ToolbarScheme

Sets a new value for property customToolbarItems.

Toolbar group for custom toolbar items

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

Parameters:

{sap.gantt.config.ToolbarGroup} sCustomToolbarItems New value for property customToolbarItems

Returns:

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

setExpandChart(sExpandChart): sap.gantt.config.ToolbarScheme

Sets a new value for property expandChart.

Toolbar group for expanding a chart

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

Parameters:

{sap.gantt.config.ExpandChartGroup} sExpandChart New value for property expandChart

Returns:

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

setExpandTree(sExpandTree): sap.gantt.config.ToolbarScheme

Sets a new value for property expandTree.

Toolbar group for expanding nodes of a tree table

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

Parameters:

{sap.gantt.config.ToolbarGroup} sExpandTree New value for property expandTree

Returns:

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

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

Sets a new value for property key.

Unique key of the toolbar scheme

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

setLayout(sLayout): sap.gantt.config.ToolbarScheme

Sets a new value for property layout.

Toolbar group for the Gantt chart layout

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

Parameters:

{sap.gantt.config.LayoutGroup} sLayout New value for property layout

Returns:

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

setLegend(sLegend): sap.gantt.config.ToolbarScheme

Sets a new value for property legend.

Toolbar group for legend

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

Parameters:

{sap.gantt.config.ToolbarGroup} sLegend New value for property legend

Returns:

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

setMode(sMode): sap.gantt.config.ToolbarScheme

Sets a new value for property mode.

See sap.gantt.config.ModeGroup

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

Parameters:

{sap.gantt.config.ModeGroup} sMode New value for property mode

Returns:

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

setSettings(sSettings): sap.gantt.config.ToolbarScheme

Sets a new value for property settings.

See sap.gantt.config.SettingGroup

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

Parameters:

{sap.gantt.config.SettingGroup} sSettings New value for property settings

Returns:

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

setSourceSelect(sSourceSelect): sap.gantt.config.ToolbarScheme

Sets a new value for property sourceSelect.

Toolbar group for selecting a source

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

Parameters:

{sap.gantt.config.ToolbarGroup} sSourceSelect New value for property sourceSelect

Returns:

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

setTimeZoom(sTimeZoom): sap.gantt.config.ToolbarScheme

Sets a new value for property timeZoom.

Toolbar group for the time zoom

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

Parameters:

{sap.gantt.config.ToolbarGroup} sTimeZoom New value for property timeZoom

Returns:

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

setToolbarDesign(sToolbarDesign): sap.gantt.config.ToolbarScheme

Sets a new value for property toolbarDesign.

Toolbar design. See sap.m.ToolbarDesign

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

Default value is sap.m.ToolbarDesign.Auto.

Parameters:

{string} sToolbarDesign New value for property toolbarDesign

Returns:

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