Class sap.gantt.shape.ext.CursorModule: sap/gantt/shape/ext/Cursor

Cursor shape class using SVG tag 'path'. It's usually treated as a transient shape.

See SVG specification 1.1 for the 'path' element for detail information of the html tag.

The following SVG image shows how the properties are designed:
timerotationCenterlengthwidthpointHeight

Constructor Summary
new sap.gantt.shape.ext.Cursor(sId?, mSettings?)Creates and initializes a new Cursor class.
Method Summary
sap.gantt.shape.ext.Cursor.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.shape.ext.Cursor with name sClassName and enriches it with the information contained in oClassInfo.
sap.gantt.shape.ext.Cursor.getMetadata()Returns a metadata object for class sap.gantt.shape.ext.Cursor.
getD(oData, oRowInfo)Gets the value of property d.
getIsClosed(oData, oRowInfo)Gets the value of property isClosed.
getLength(oData, oRowInfo)Gets the value of property length.
getPointHeight(oData, oRowInfo)Gets the value of property pointHeight.
getWidth(oData, oRowInfo)Gets the value of property width.
setIsClosed(bIsClosed)Sets a new value for property isClosed.
setLength(sLength)Sets a new value for property length.
setPointHeight(sPointHeight)Sets a new value for property pointHeight.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.gantt.shape.ext.Cursor(sId?, mSettings?)
Creates and initializes a new Cursor class.

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:

Parameters:
{string}sId? ID of the new control, generated automatically if no ID is given
{object}mSettings? Initial settings of the new control
Method Detail
sap.gantt.shape.ext.Cursor.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.shape.ext.Cursor with name sClassName and enriches it with the information contained in oClassInfo.

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

d attribute of the path element. See SVG 1.1 specification for 'd' attribute of 'path'.

Your application should not configure this value. Instead, the getter calculates the value of d by using properties length, width, and pointHeight. The value of these properties can be retrieved using the corresponding getters (getLength, getWidth, and getPointHeight).

Parameters:
{object}oData Shape data.
{object}oRowInfo Information about the row and row data.
Returns:
{string} Value of property d.
getIsClosed(oData, oRowInfo): boolean
Gets the value of property isClosed.
Parameters:
{object}oData Shape data.
{object}oRowInfo Information about the row and row data.
Returns:
{boolean} Value of property isClosed.
getLength(oData, oRowInfo): number
Gets the value of property length.

Length of a cursor.

This property influences property d.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information about the row and row data.
Returns:
{number} Value of property length.
getPointHeight(oData, oRowInfo): number
Gets the value of property pointHeight.

Point height of a cursor.

This property influences property d.

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

Width of a cursor.

This property influences property d.

Parameters:
{object}oData Shape data.
{object}oRowInfo Information about the row and row data.
Returns:
{number} Value of property width.
setIsClosed(bIsClosed): sap.gantt.shape.ext.Cursor
Sets a new value for property isClosed.

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

Default value is true.

Parameters:
{boolean}bIsClosed New value for property isClosed
Returns:
{sap.gantt.shape.ext.Cursor} Reference to this in order to allow method chaining
setLength(sLength): sap.gantt.shape.ext.Cursor
Sets a new value for property length.

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

Default value is 10.

Parameters:
{number}sLength New value for property length
Returns:
{sap.gantt.shape.ext.Cursor} Reference to this in order to allow method chaining
setPointHeight(sPointHeight): sap.gantt.shape.ext.Cursor
Sets a new value for property pointHeight.

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

Default value is 5.

Parameters:
{number}sPointHeight New value for property pointHeight
Returns:
{sap.gantt.shape.ext.Cursor} Reference to this in order to allow method chaining
setWidth(sWidth): sap.gantt.shape.ext.Cursor
Sets a new value for property width.

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

Default value is 5.

Parameters:
{number}sWidth New value for property width
Returns:
{sap.gantt.shape.ext.Cursor} Reference to this in order to allow method chaining