Scribd
Upload
16 views2 pages

Adding Method Implementations 91f0a8d

This document provides guidelines for adding method implementations to custom controls in SAPUI5, including: - Method names should not overwrite superclass methods or use reserved names like set/get. - Common method names like on, init, and renderer have specific meanings. - Overriding superclass methods requires calling the superclass implementation to avoid breaking inheritance. - User input must be escaped when writing to HTML to prevent XSS issues.

Uploaded by

zzg
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
16 views2 pages

Adding Method Implementations 91f0a8d

This document provides guidelines for adding method implementations to custom controls in SAPUI5, including: - Method names should not overwrite superclass methods or use reserved names like set/get. - Common method names like on, init, and renderer have specific meanings. - Overriding superclass methods requires calling the superclass implementation to avoid breaking inheritance. - User input must be escaped when writing to HTML to prevent XSS issues.

Uploaded by

zzg
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

loio

91f0a8dc6f4d1014b6dd926db0e91070
view on: demo kit nightly build | demo kit latest release

Adding Method Implementations


After defining the metadata of a control, you add the method implementation to the control.
The following restrictions apply with regard to the method names:
• Do not use names of methods that are or will be provided by a superclass. Due to
inheritance, your implementation would overwrite the implementation of the
superclass.

• Names starting with


set.../get.../insert.../add.../remove.../indexOf.../destroy... shall not be
used because they may collide with setters/getters for properties or aggregations that
are defned explicitely or by a superclass.

• Names starting with attach.../detach.../fire may collide with methods created


for events.

The following method names have a specific meaning and should be used accordingly:
• on...: Used for event handlers that are automatically bound to browser events

• init: Used for the initialization function that is called after control instantiation

• renderer: Used for the function that creates the control’s HTML

Note: Any method in your inheriting control overrides methods with the same name in the superclass. If, for
example, your control implements the init() method, the init() of the superclass will no longer be
executed. The control is then no longer properly initialized and this typically causes an error. To avoid breaking the
control, call the superclass method.
Consider also that the superclass might implement the method later on, or removes its own method
implementation because it is not needed anymore. We recommend that you check for the existence of the
superclass method before calling it:

sap.ui.somelib.SomeControl.extend("my.OwnControl", {
...
init: function() {
if (sap.ui.somelib.SomeControl.prototype.init) { // check
whether superclass implements the method
sap.ui.somelib.SomeControl.prototype.init.apply(this,
arguments); // call the method with the original arguments
}

//... do any further initialization of your subclass...


}
Note: When you modify the HTML of a control using the code in the control behavior file, make sure to escape any
unchecked data you write with jQuery.sap.encodeHTML(...) to prevent cross-site-scripting issues. For
more information, see Cross-Site Scripting.

You might also like