Provides a control for designing redlining shapes.
Constructor for a new RedlineDesign.
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.RedlineDesign()
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
activeElementInstance | 0..1 | sap.ui.vk.RedlineElement |
activeElementInstance is the element being currently drawn. |
Name | Cardinality | Type | Description |
---|---|---|---|
redlineElements | 0..n | sap.ui.vk.RedlineElement |
Method | Description |
---|---|
attachElementCreated |
Attaches event handler When called, the context of the event handler (its |
detachElementCreated |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.RedlineDesign.extend |
Creates a new subclass of class sap.ui.vk.RedlineDesign with name
|
fireElementCreated |
Fires event elementCreated to attached listeners. |
sap.ui.vk.RedlineDesign.getMetadata |
Returns a metadata object for class sap.ui.vk.RedlineDesign. |
startAdding |
Prepares the RedlineDesign control for adding a new instance of {sap.ui.vk.RedlineElement}. |
stopAdding |
Stops the mode for adding redlining, which begins when the startAdding method is called. |
Attaches event handler fnFunction
to the elementCreated event of this sap.ui.vk.RedlineDesign
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.vk.RedlineDesign
itself.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the elementCreated event of this sap.ui.vk.RedlineDesign
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.ui.vk.RedlineDesign 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.RedlineSurface.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 |
Fires event elementCreated to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
element | object |
Prepares the RedlineDesign control for adding a new instance of {sap.ui.vk.RedlineElement}.
Param | Type | DefaultValue | Description |
---|---|---|---|
elementInstance | sap.ui.vk.RedlineElement |
The redlining element which needs to be added. |