Class sap.gantt.shape.cal.CalendarModule: sap/gantt/shape/cal/Calendar

extends Rectangle

Calendar shape.

The Calendar shape must be used in combination with Calendar def class sap.gantt.def.cal.Calendar which draws SVG 'defs' tag.

Constructor Summary
new sap.gantt.shape.cal.Calendar(sId?, mSettings?)Creates a Calendar shape which consumes pattern from Calendar in 'def' package.
Method Summary
sap.gantt.shape.cal.Calendar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.shape.cal.Calendar with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.shape.cal.Calendar.getMetadata()Returns a metadata object for class sap.gantt.shape.cal.Calendar.
getCalendarName(oData, oRowInfo)Gets the value of property calendarName.
getEnableSelection(oData, oRowInfo)Gets current value of property enableSelection.
getFill(oData, oRowInfo)Gets current value of property fill.
getHeight(oData, oRowInfo)Gets current value of property height.
getIsBulk(oData, oRowInfo)Gets current value of property isBulk.
getWidth(oData, oRowInfo)Gets current value of property width.
getX(oData, oRowInfo)Gets current value of property x.
getY(oData, oRowInfo)Gets current value of property y.
setCalendarName(sCalendarName)Sets a new value for property calendarName.
setEnableSelection(bEnableSelection)Sets a new value for property enableSelection.
setIsBulk(bIsBulk)Sets a new value for property isBulk.
Methods borrowed from class sap.gantt.shape.Rectangle
getIsDuration, getRx, getRy, getTag, setHeight, setIsDuration, setRx, setRy, setTag, setWidth, setX, setY
Constructor Detail
new sap.gantt.shape.cal.Calendar(sId?, mSettings?)
Creates a Calendar shape which consumes pattern from Calendar in 'def' package.

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:

In addition, all settings applicable to the base type sap.gantt.shape.Rectangle 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.shape.cal.Calendar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.shape.cal.Calendar with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.gantt.shape.Rectangle.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.shape.cal.Calendar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.gantt.shape.cal.Calendar.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getCalendarName(oData, oRowInfo): string
Gets the value of property calendarName.

Calendar key.

This property is used to generate referencing string to compose the fill property. This property is must provided.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information about the row and the row data.
Returns:
{string} Value of property calendarName.
getEnableSelection(oData, oRowInfo): boolean
Gets current value of property enableSelection.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{boolean} Value of property enableSelection.
getFill(oData, oRowInfo): string
Gets current value of property fill.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{string} Value of property fill.
getHeight(oData, oRowInfo): number
Gets current value of property height.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{number} Value of property height.
getIsBulk(oData, oRowInfo): boolean
Gets current value of property isBulk.

General recommendation is don't configure or code against this property.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{boolean} Value of property isBulk.
getWidth(oData, oRowInfo): number
Gets current value of property width.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{number} Value of property width.
getX(oData, oRowInfo): number
Gets current value of property x.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{number} Value of property x.
getY(oData, oRowInfo): number
Gets current value of property y.

General recommendation is don't configure or code against this property. Calendar is treated as a bulk shape filled with pattern occupying visible chart area. Application should implement their own shape if a select able calendar is expected.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information of the row and row data.
Returns:
{number} Value of property y.
setCalendarName(sCalendarName): sap.gantt.shape.cal.Calendar
Sets a new value for property calendarName.

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

Default value is nwt.

Parameters:
{string}sCalendarName New value for property calendarName
Returns:
{sap.gantt.shape.cal.Calendar} Reference to this in order to allow method chaining
setEnableSelection(bEnableSelection): sap.gantt.shape.cal.Calendar
Sets a new value for property enableSelection.

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

Default value is false.

Parameters:
{boolean}bEnableSelection New value for property enableSelection
Returns:
{sap.gantt.shape.cal.Calendar} Reference to this in order to allow method chaining
setIsBulk(bIsBulk): sap.gantt.shape.cal.Calendar
Sets a new value for property isBulk.

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

Default value is true.

Parameters:
{boolean}bIsBulk New value for property isBulk
Returns:
{sap.gantt.shape.cal.Calendar} Reference to this in order to allow method chaining