ContainerLayout

extends Element

Defines the container layout. The container layout determines the layout of a Gantt chart container such as the CSS size, orientation, toolbar, and tree table size.

Constructor Summary

new sap.gantt.config.ContainerLayout(sId?, mSettings?)Creates and initializes a new container layout

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

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

getActiveModeKey()Gets current value of property activeModeKey.

getGanttChartLayouts()Gets current value of property ganttChartLayouts.

getKey()Gets current value of property key.

getOrientation()Gets current value of property orientation.

getSelectionPanelSize()Gets current value of property selectionPanelSize.

getText()Gets current value of property text.

getToolbarSchemeKey()Gets current value of property toolbarSchemeKey.

setActiveModeKey(sActiveModeKey)Sets a new value for property activeModeKey.

setGanttChartLayouts(sGanttChartLayouts)Sets a new value for property ganttChartLayouts.

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

setOrientation(sOrientation)Sets a new value for property orientation.

setSelectionPanelSize(sSelectionPanelSize)Sets a new value for property selectionPanelSize.

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

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

Creates and initializes a new container layout

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_CONTAINER_SINGLE_LAYOUT_KEY)
- text : string (default: ???)
- orientation : sap.ui.core.Orientation (default: Vertical)
- activeModeKey : string (default: sap.gantt.config.DEFAULT_MODE_KEY)
- toolbarSchemeKey : string (default: sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY)
- selectionPanelSize : sap.ui.core.CSSSize (default: 30%)
- ganttChartLayouts : array (default: [])

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

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getActiveModeKey(): string

Gets current value of property activeModeKey.

Active mode key. See sap.gantt.config.Mode

Default value is sap.gantt.config.DEFAULT_MODE_KEY.

Returns:

{string} Value of property activeModeKey

getGanttChartLayouts(): array

Gets current value of property ganttChartLayouts.

Array of the Gantt chart layout. See sap.gantt.config.GanttChartLayout

Default value is [].

Returns:

{array} Value of property ganttChartLayouts

getKey(): string

Gets current value of property key.

Unique key of the container layout

Default value is sap.gantt.config.DEFAULT_CONTAINER_SINGLE_LAYOUT_KEY.

Returns:

{string} Value of property key

getOrientation(): sap.ui.core.Orientation

Gets current value of property orientation.

Orientation of the Gantt chart container. See sap.ui.core.Oritentation

Default value is Vertical.

Returns:

{sap.ui.core.Orientation} Value of property orientation

getSelectionPanelSize(): sap.ui.core.CSSSize

Gets current value of property selectionPanelSize.

CSS size of the selection panel. See sap.ui.core.CSSSize

Default value is 30%.

Returns:

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

getText(): string

Gets current value of property text.

Default value is ???.

Returns:

{string} Value of property text

getToolbarSchemeKey(): string

Gets current value of property toolbarSchemeKey.

Toolbar scheme key. See sap.gantt.config.ToolbarScheme

Default value is sap.gantt.config.DEFAULT_CONTAINER_TOOLBAR_SCHEME_KEY.

Returns:

{string} Value of property toolbarSchemeKey

setActiveModeKey(sActiveModeKey): sap.gantt.config.ContainerLayout

Sets a new value for property activeModeKey.

Active mode key. See 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.ContainerLayout} Reference to this in order to allow method chaining

setGanttChartLayouts(sGanttChartLayouts): sap.gantt.config.ContainerLayout

Sets a new value for property ganttChartLayouts.

Array of the Gantt chart layout. See sap.gantt.config.GanttChartLayout

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

Default value is [].

Parameters:

{array} sGanttChartLayouts New value for property ganttChartLayouts

Returns:

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

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

Sets a new value for property key.

Unique key of the container layout

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_CONTAINER_SINGLE_LAYOUT_KEY.

Parameters:

{string} sKey New value for property key

Returns:

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

setOrientation(sOrientation): sap.gantt.config.ContainerLayout

Sets a new value for property orientation.

Orientation of the Gantt chart container. See sap.ui.core.Oritentation

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

Default value is Vertical.

Parameters:

{sap.ui.core.Orientation} sOrientation New value for property orientation

Returns:

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

setSelectionPanelSize(sSelectionPanelSize): sap.gantt.config.ContainerLayout

Sets a new value for property selectionPanelSize.

CSS size of the selection panel. See sap.ui.core.CSSSize

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

Default value is 30%.

Parameters:

{sap.ui.core.CSSSize} sSelectionPanelSize New value for property selectionPanelSize

Returns:

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

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

Sets a new value for property text.

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

Default value is ???.

Parameters:

{string} sText New value for property text

Returns:

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

setToolbarSchemeKey(sToolbarSchemeKey): sap.gantt.config.ContainerLayout

Sets a new value for property toolbarSchemeKey.

Toolbar scheme key. See 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_CONTAINER_TOOLBAR_SCHEME_KEY.

Parameters:

{string} sToolbarSchemeKey New value for property toolbarSchemeKey

Returns:

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