Class sap.apf.base.ComponentModule: sap/apf/base/Component

extends UIComponent

Base Component for all APF based applications.


Since: SAP UI5 1.30.0..
Constructor Summary
new sap.apf.base.Component()
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.apf.base.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.apf.base.Component with name sClassName and enriches it with the information contained in oClassInfo.
sap.apf.base.Component.getMetadata()Returns a metadata object for class sap.apf.base.Component.
createContent()Creates the content of the component.
exit()Cleanup the Component instance.
getApi()Returns the instance of the APF API.
getInjections()This function is optional and can be implemented in any extending Component.js.
Methods borrowed from class sap.ui.core.UIComponent
byId, createId, getAutoPrefixId, getEventingParent, getRouter, getTargets, getUIArea, init, onAfterRendering, onBeforeRendering, render, setContainer
Methods borrowed from class sap.ui.core.Component
getComponentData, getEventBus, getInterface, getManifest, getManifestEntry, getManifestObject, getMetadata, getService, onConfigChange, onWindowBeforeUnload, onWindowError, onWindowUnload, runAsOwner
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, clone, destroy, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, toString, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, fireEvent, hasListeners
Constructor Detail
new sap.apf.base.Component()
Method Detail
sap.apf.base.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.apf.base.Component 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.UIComponent.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.apf.base.Component.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.apf.base.Component.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
createContent(): sap.ui.core.Control
Creates the content of the component. A component that extends this component shall call this method.
Returns:
{sap.ui.core.Control} the content
exit()
Cleanup the Component instance. The component that extends this component should call this method.
getApi(): sap.apf.Api
Returns the instance of the APF API.
Returns:
{sap.apf.Api}
getInjections(): object
This function is optional and can be implemented in any extending Component.js. Its return value is an object containing injected constructors, functions, references and exits. The injected sub entities are all optional and will be used by the APF logic when defined. Exits are used to change predefined enhancement points. Instances, functions and constructors are used for test isolation. Probe is used in tests to access internal APF references.

Experimental API:NOT FOR PRODUCTION USE

Experimental:
NOT FOR PRODUCTION USE
Since:
1.38.4
Returns:
{object} Object containing optional injects and exits