Iconfont shape class using SVG tag 'text'. This shape is usually used to display icons in Gantt chart.
Method Summary
sap.gantt.shape.ext.Iconfont.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.shape.ext.Iconfont with name sClassName
and enriches it with the information contained in oClassInfo
. getFontFamily(oData, oRowInfo)Gets the value of property fontFamily
. getName(oData)Gets the value of property name
. getText(oData, oRowInfo)Gets the value of property text
. setName(sName)Sets a new value for property name
. Constructor Detail
new sap.gantt.shape.ext.Iconfont(sId?, mSettings?)
Creates and initializes a new Iconfont 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 for the new control, generated automatically if no ID is given |
{object} | mSettings? | Initial settings for the new control |
Method Detail
sap.gantt.shape.ext.Iconfont.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.shape.ext.Iconfont 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 |
Returns a metadata object for class sap.gantt.shape.ext.Iconfont.
Returns:
getCollectionName(oData): string
Gets the value of property
collectionName
.
The collectionName of iconfont as mentioned in property text
Parameters:
{object} | oData | Shape data. |
Returns:
{string} | Value of property collectionName . |
getFontFamily(oData, oRowInfo): string
Gets the value of property
fontFamily
.
Font family of Iconfont.
Parameters:
{object} | oData | Shape data. |
{object} | oRowInfo | Information about the row and the row data. |
Returns:
{string} | Value of property fontFamily . |
getName(oData): string
Gets the value of property
name
.
The name of iconfont as mentioned in property text
Parameters:
{object} | oData | Shape data. |
Returns:
{string} | Value of property name . |
getText(oData, oRowInfo): string
Gets the value of property
text
.
The text string of iconfont is read via sap.ui.IconPool.getIconInfo passing Name and CollectionName as parameters. To use the SAP openui5 predefined icons, don't set the property CollectionName. To use the icons in other collections, you need register first. For example, after calling function sap.ushell.iconfonts.registerFiori2IconFont, then you can use the icon collection with names "BusinessSuiteInAppSymbols", "Fiori2"...
Parameters:
{object} | oData | Shape data. |
{object} | oRowInfo | Information about the row and the row data. |
Returns:
{string} | Value of property text . |
Sets a new value for property
collectionName
.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:
{string} | sCollectionName | New value for property collectionName |
Returns:
Sets a new value for property
name
.
When called with a value of null
or undefined
, the default value of the property will be restored.
Parameters:
{string} | sName | New value for property name |
Returns: