Locale

The locale control is used for converting the UTC date time to your local date time

Constructor Summary

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

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

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

getDstHorizons()Gets current value of property dstHorizons.

getTimeZone()Gets current value of property timeZone.

getUtcdiff()Gets current value of property utcdiff.

getUtcsign()Gets current value of property utcsign.

setDstHorizons(sDstHorizons)Sets a new value for property dstHorizons.

setTimeZone(sTimeZone)Sets a new value for property timeZone.

setUtcdiff(sUtcdiff)Sets a new value for property utcdiff.

setUtcsign(sUtcsign)Sets a new value for property utcsign.

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

Creates and initializes a new Locale

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
- timeZone : string (default: UTC)
- utcdiff : string (default: 000000)
- utcsign : string (default: +)
- dstHorizons : 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.Locale.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getDstHorizons(): array

Gets current value of property dstHorizons.

Day-light saving time periods. Array of sap.gantt.config.TimeHorizon

Default value is [].

Returns:

{array} Value of property dstHorizons

getTimeZone(): string

Gets current value of property timeZone.

User time zone

Default value is UTC.

Returns:

{string} Value of property timeZone

getUtcdiff(): string

Gets current value of property utcdiff.

Gap value to the UTC time in the format hhmmss

Default value is 000000.

Returns:

{string} Value of property utcdiff

getUtcsign(): string

Gets current value of property utcsign.

Sign of the gap to the UTC time. Two valid values: "+" or "-".

Default value is +.

Returns:

{string} Value of property utcsign

setDstHorizons(sDstHorizons): sap.gantt.config.Locale

Sets a new value for property dstHorizons.

Day-light saving time periods. Array of sap.gantt.config.TimeHorizon

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

Default value is [].

Parameters:

{array} sDstHorizons New value for property dstHorizons

Returns:

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

setTimeZone(sTimeZone): sap.gantt.config.Locale

Sets a new value for property timeZone.

User time zone

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

Default value is UTC.

Parameters:

{string} sTimeZone New value for property timeZone

Returns:

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

setUtcdiff(sUtcdiff): sap.gantt.config.Locale

Sets a new value for property utcdiff.

Gap value to the UTC time in the format hhmmss

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

Default value is 000000.

Parameters:

{string} sUtcdiff New value for property utcdiff

Returns:

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

setUtcsign(sUtcsign): sap.gantt.config.Locale

Sets a new value for property utcsign.

Sign of the gap to the UTC time. Two valid values: "+" or "-".

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

Default value is +.

Parameters:

{string} sUtcsign New value for property utcsign

Returns:

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