Abstract Class sap.ui.base.ObjectModule: sap/ui/base/Object


Base class for all SAPUI5 Objects
Constructor Summary
new sap.ui.base.Object()Constructor for an sap.ui.base.Object.
Method Summary
sap.ui.base.Object.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a subclass of class sap.ui.base.Object with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.base.Object.isA(oObject, vTypeName)Checks whether the given object is an instance of the named type.
destroy()Destructor method for objects
getInterface()Returns the public interface of the object.
getMetadata()Returns the metadata for the class that this object belongs to.
isA(vTypeName)Checks whether this object is an instance of the named type.
sap.ui.base.Object.defineClass(sClassName, oStaticInfo, FNMetaImpl?)Creates metadata for a given class and attaches it to the constructor and prototype of that class.
Constructor Detail
new sap.ui.base.Object()
Constructor for an sap.ui.base.Object.
Method Detail
sap.ui.base.Object.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a subclass of class sap.ui.base.Object with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain three kinds of information:

  • metadata: an (optional) object literal with metadata about the class. The information in the object literal will be wrapped by an instance of Metadata and might contain the following information

    • interfaces: {string[]} (optional) set of names of implemented interfaces (defaults to no interfaces)
    • publicMethods: {string[]} (optional) list of methods that should be part of the public facade of the class
    • abstract: {boolean} (optional) flag that marks the class as abstract (purely informational, defaults to false)
    • final: {boolean} (optional) flag that marks the class as final (defaults to false)

    Subclasses of sap.ui.base.Object can enrich the set of supported metadata (e.g. see sap.ui.core.Element.extend).

  • constructor: a function that serves as a constructor function for the new class. If no constructor function is given, the framework creates a default implementation that delegates all its arguments to the constructor function of the base class.
  • any-other-name: any other property in the oClassInfo is copied into the prototype object of the newly created class. Callers can thereby add methods or properties to all instances of the class. But be aware that the given values are shared between all instances of the class. Usually, it doesn't make sense to use primitive values here other than to declare public constants.

The prototype object of the newly created class uses the same prototype as instances of the base class (prototype chaining).

A metadata object is always created, even if there is no metadata entry in the oClassInfo object. A getter for the metadata is always attached to the prototype and to the class (constructor function) itself.

Last but not least, with the third argument FNMetaImpl the constructor of a metadata class can be specified. Instances of that class will be used to represent metadata for the newly created class and for any subclass created from it. Typically, only frameworks will use this parameter to enrich the metadata for a new class hierarchy they introduce (e.g. Element).

Parameters:
stringsClassNamename of the class to be created
objectoClassInfo?structured object with information about the class
functionFNMetaImpl?constructor function for the metadata object. If not given, it defaults to sap.ui.base.Metadata.
Returns:
functionthe created class / constructor function
Since:
1.3.1
sap.ui.base.Object.isA(oObject, vTypeName): boolean

Checks whether the given object is an instance of the named type. This function is a short-hand convenience for sap.ui.base.Object#isA.

Please see the API documentation of sap.ui.base.Object#isA for more details.

Parameters:
objectoObjectObject which will be checked whether it is an instance of the given type
string|string[]vTypeNameType or types to check for
Returns:
booleanWhether the given object is an instance of the given type or of any of the given types
Since:
1.56
destroy()
Destructor method for objects
getInterface(): sap.ui.base.Interface
Returns the public interface of the object.
Returns:
sap.ui.base.Interfacethe public interface of the object
getMetadata(): sap.ui.base.Metadata

Returns the metadata for the class that this object belongs to.

This method is only defined when metadata has been declared by using sap.ui.base.Object.defineClass or sap.ui.base.Object.extend.

Returns:
sap.ui.base.Metadatametadata for the class of the object
isA(vTypeName): boolean

Checks whether this object is an instance of the named type.

This check is solely based on the type names as declared in the class metadata. It compares the given vTypeName with the name of the class of this object, with the names of any base class of that class and with the names of all interfaces implemented by any of the aforementioned classes.

Instead of a single type name, an array of type names can be given and the method will check if this object is an instance of any of the listed types (logical or).

Should the UI5 class system in future implement additional means of associating classes with type names (e.g. by introducing mixins), then this method might detect matches for those names as well.

Parameters:
string|string[]vTypeNameType or types to check for
Returns:
booleanWhether this object is an instance of the given type or of any of the given types
Since:
1.56
sap.ui.base.Object.defineClass(sClassName, oStaticInfo, FNMetaImpl?): sap.ui.base.Metadata

Creates metadata for a given class and attaches it to the constructor and prototype of that class.

After creation, metadata can be retrieved with getMetadata().

The static info can at least contain the following entries:

  • baseType: {string} fully qualified name of a base class or empty
  • publicMethods: {string} an array of method names that will be visible in the interface proxy returned by getInterface
Parameters:
stringsClassNamename of an (already declared) constructor function
objectoStaticInfostatic info used to create the metadata object
stringoStaticInfo.baseTypequalified name of a base class
string[]oStaticInfo.publicMethodsarray of names of public methods
functionFNMetaImpl?constructor function for the metadata object. If not given, it defaults to sap.ui.base.Metadata.
Returns:
sap.ui.base.Metadatathe created metadata object
Deprecated API:
Since 1.3.1. Use the static extend method of the desired base class (e.g. sap.ui.base.Object.extend)