Provides a control for creating text redline elements.
Redline element control for text.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vk.RedlineElementText()
Name | Type | Default Value | Description |
---|---|---|---|
fillColor | sap.ui.core.CSSColor | rgba(0,0,0,0) | Visibility: public |
font | string | empty string | Visibility: public |
fontSize | float | 32 | Visibility: public |
height | float | 0 | Visibility: public |
text | string | Text | Visibility: public |
width | float | 300 | Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
createTimestamp | int | Visibility: public | |
createdByUser | any | empty string | Visibility: public |
deleteTimestamp | int | Visibility: public | |
deletedByUser | any | empty string | Visibility: public |
elementId | string | Visibility: public | |
halo | boolean | false | Visibility: public |
haloColor | string | rgba(255, 0, 0, 1) | Visibility: public |
opacity | float | 1 | Visibility: public |
originX | float | 0 | Visibility: public |
originY | float | 0 | Visibility: public |
strokeColor | sap.ui.core.CSSColor | #e6600d | Visibility: public |
strokeDashArray | float[] | Visibility: public | |
strokeWidth | float | 2 | Visibility: public |
suppress | boolean | false | Visibility: public |
Method | Description |
---|---|
applyZoom |
Changes the current font size of the text redline element by a factor which gets passed as parameter. |
edit |
Changes the current originX and originY of the text redline element with the values passed as parameters. |
exportJSON |
Exports all the relevant data contained in the text redline element to a JSON object. |
exportSVG |
Exports all the relevant data contained in the text redline element to an SVG text element. |
sap.ui.vk.RedlineElementText.extend |
Creates a new subclass of class sap.ui.vk.RedlineElementText with name
|
getFillColor |
Gets current value of property fillColor. Default value is |
getFont |
Gets current value of property font. Default value is |
getFontSize |
Gets current value of property fontSize. Default value is |
getHeight |
Gets current value of property height. Default value is |
sap.ui.vk.RedlineElementText.getMetadata |
Returns a metadata object for class sap.ui.vk.RedlineElementText. |
getText |
Gets current value of property text. Default value is |
getWidth |
Gets current value of property width. Default value is |
importJSON |
Imports data from a JSON object into the text redline element. |
importSVG |
Imports data from an SVG text element into the text redline element. |
setFillColor |
Sets a new value for property fillColor. When called with a value of Default value is |
setFont |
Sets a new value for property font. When called with a value of Default value is |
setFontSize |
Sets a new value for property fontSize. When called with a value of Default value is |
setHeight |
Sets a new value for property height. When called with a value of Default value is |
setText |
Sets a new value for property text. When called with a value of Default value is |
setWidth |
Sets a new value for property width. When called with a value of Default value is |
Changes the current font size of the text redline element by a factor which gets passed as parameter.
Param | Type | DefaultValue | Description |
---|---|---|---|
zoomBy | number |
The factor to be applied to the current font size. |
Changes the current originX and originY of the text redline element with the values passed as parameters.
Param | Type | DefaultValue | Description |
---|---|---|---|
posX | number |
The value in pixels that will be set as originX for the text. |
|
posY | number |
The value in pixels that will be set as originY for the text. |
Exports all the relevant data contained in the text redline element to an SVG text element.
Creates a new subclass of class sap.ui.vk.RedlineElementText 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.vk.RedlineElement.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Returns a metadata object for class sap.ui.vk.RedlineElementText.
Imports data from a JSON object into the text redline element.
Param | Type | DefaultValue | Description |
---|---|---|---|
json | object |
Relevant data used to restore the text redline element. |
Imports data from an SVG text element into the text redline element.
Param | Type | DefaultValue | Description |
---|---|---|---|
element | object |
SVG text element used to restore the text redline element. |
Sets a new value for property fillColor.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "rgba(0,0,0,0)"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFillColor | sap.ui.core.CSSColor | "rgba(0,0,0,0)" |
New value for property |
Sets a new value for property font.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sFont | string | "" |
New value for property |
Sets a new value for property fontSize.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 32
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fFontSize | float | 32 |
New value for property |
Sets a new value for property height.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 0
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fHeight | float | 0 |
New value for property |
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 "Text"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string | "Text" |
New value for property |
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 300
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fWidth | float | 300 |
New value for property |