Provides a base class for redline elements.
Base class for redline elements such as sap.ui.vk.RedlineElementRectangle, sap.ui.vk.RedlineElementEllipse, sap.ui.vk.RedlineElementFreehand, sap.ui.vk.RedlineElementLine, sap.ui.vk.RedlineElementText.
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.RedlineElement()
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 |
---|---|
exportJSON |
Exports all the relevant data contained in the redline element to a JSON-like object. |
exportSVG |
Exports all the relevant data contained in the redline element to an SVG shape element. |
sap.ui.vk.RedlineElement.extend |
Creates a new subclass of class sap.ui.vk.RedlineElement with name
|
getCreatedByUser |
Gets current value of property createdByUser. Default value is |
getCreateTimestamp |
Gets current value of property createTimestamp. |
getDeletedByUser |
Gets current value of property deletedByUser. Default value is |
getDeleteTimestamp |
Gets current value of property deleteTimestamp. |
getElementId |
Gets current value of property elementId. |
getHalo |
Gets current value of property halo. Default value is |
getHaloColor |
Gets current value of property haloColor. Default value is |
sap.ui.vk.RedlineElement.getMetadata |
Returns a metadata object for class sap.ui.vk.RedlineElement. |
getOpacity |
Gets current value of property opacity. Default value is |
getOriginX |
Gets current value of property originX. Default value is |
getOriginY |
Gets current value of property originY. Default value is |
getStrokeColor |
Gets current value of property strokeColor. Default value is |
getStrokeDashArray |
Gets current value of property strokeDashArray. Default value is |
getStrokeWidth |
Gets current value of property strokeWidth. Default value is |
getSuppress |
Gets current value of property suppress. Default value is |
importJSON |
Imports data from a JSON-like object into the redline element. |
importSVG |
Imports data from an SVG shape element into the redline element. |
render |
This method is called by the RenderManager. The current method is empty because this is a base class and the classes extending this class have their own implementations of the |
renderElement |
This method is called by the RenderManager. The current method is empty because this is a base class and the classes extending this class have their own implementations of the |
setCreatedByUser |
Sets a new value for property createdByUser. When called with a value of Default value is |
setCreateTimestamp |
Sets a new value for property createTimestamp. When called with a value of |
setDeletedByUser |
Sets a new value for property deletedByUser. When called with a value of Default value is |
setDeleteTimestamp |
Sets a new value for property deleteTimestamp. When called with a value of |
setElementId |
Sets a new value for property elementId. When called with a value of |
setHalo |
Sets a new value for property halo. When called with a value of Default value is |
setHaloColor |
Sets a new value for property haloColor. When called with a value of Default value is |
setOpacity |
Sets a new value for property opacity. When called with a value of Default value is |
setOriginX |
Sets a new value for property originX. When called with a value of Default value is |
setOriginY |
Sets a new value for property originY. When called with a value of Default value is |
setStrokeColor |
Sets a new value for property strokeColor. When called with a value of Default value is |
setStrokeDashArray |
Sets a new value for property strokeDashArray. When called with a value of Default value is |
setStrokeWidth |
Sets a new value for property strokeWidth. When called with a value of Default value is |
setSuppress |
Sets a new value for property suppress. When called with a value of Default value is |
Creates a new subclass of class sap.ui.vk.RedlineElement 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.
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 |
Imports data from a JSON-like object into the redline element.
Param | Type | DefaultValue | Description |
---|---|---|---|
json | object |
Relevant data that can be used to restore the redline element. |
Imports data from an SVG shape element into the redline element.
Param | Type | DefaultValue | Description |
---|---|---|---|
svg | object |
SVG shape element that can be used to restore the redline element. |
This method is called by the RenderManager. The current method is empty because this is a base class and the classes extending this class have their own implementations of the render
method.
Param | Type | DefaultValue | Description |
---|---|---|---|
renderManager | sap.ui.core.RenderManager |
Instance of RenderManager. |
This method is called by the RenderManager. The current method is empty because this is a base class and the classes extending this class have their own implementations of the render
method.
Param | Type | DefaultValue | Description |
---|---|---|---|
renderManager | sap.ui.core.RenderManager |
Instance of RenderManager. |
|
halo | boolean |
If set to true then halo effect is rendered, otherwise this will do normal object rendering |
Sets a new value for property createdByUser.
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 |
---|---|---|---|
oCreatedByUser | any | "" |
New value for property |
Sets a new value for property createTimestamp.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iCreateTimestamp | int |
New value for property |
Sets a new value for property deletedByUser.
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 |
---|---|---|---|
oDeletedByUser | any | "" |
New value for property |
Sets a new value for property deleteTimestamp.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
iDeleteTimestamp | int |
New value for property |
Sets a new value for property elementId.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sElementId | string |
New value for property |
Sets a new value for property halo.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bHalo | boolean | false |
New value for property |
Sets a new value for property haloColor.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "rgba(255, 0, 0, 1)"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHaloColor | string | "rgba(255, 0, 0, 1)" |
New value for property |
Sets a new value for property opacity.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 1
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fOpacity | float | 1 |
New value for property |
Sets a new value for property originX.
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 |
---|---|---|---|
fOriginX | float | 0 |
New value for property |
Sets a new value for property originY.
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 |
---|---|---|---|
fOriginY | float | 0 |
New value for property |
Sets a new value for property strokeColor.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is "#e6600d"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sStrokeColor | sap.ui.core.CSSColor | "#e6600d" |
New value for property |
Sets a new value for property strokeDashArray.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is []
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sStrokeDashArray | float[] | [] |
New value for property |
Sets a new value for property strokeWidth.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is 2
.
Param | Type | DefaultValue | Description |
---|---|---|---|
fStrokeWidth | float | 2 |
New value for property |
Sets a new value for property suppress.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSuppress | boolean | false |
New value for property |