Skip to Content
Technical Articles
Author's profile photo Dhanasupriya Sidagam

API Reference of SAP UI5 SDK

Hello SAP Community

With the present blog, i stick to detail the importance of SAP UI5 Libraries, classes, constructors, properties, aggregations, associations, events and methods. In precise, i just indicated about SAP UI5 API Reference from SAP UI5 SDK: https://sapui5.hana.ondemand.com/#/api

Below is the skeleton of SAP UI5 framework.

The flowchart cited over is nothing but the one related to SAP UI5 SDK.

SAP UI5 developers/beginners may hit around SAP UI5 SDK frequently. Yet, few might not be insightful what it is for. This illustration may support them or to the one’s who just evoked to soak into SAP UI5.

Constructor: It is defined with the id and necessary settings based on our want.

new sap.m.Button(sId, mSettings)
	var oRadioButton = new RadioButton("oControllerRadio", {
				text: "Features",
				selected: true,
				tooltip:"Aggregation of Radio Button"
			});

Properties: tells about how particular control will display on the screen with its predefined attributes.

Aggregations: this tag usually serves as a direct child of a container and contains children.

Associations: One control can be labelled/manipulated with the help of other control. Advantage of this is both can be created and deleted independently.

Events: Helps to behave an activity on the SAP UI5 controls from the UI screen.

Methods: For the properties stated above, we can work for getter & setter methods which means to get/set the properties.

Below example refers the API Reference of SAP UI5 SDK.

<mvc:View controllerName="com.RadioButton.controller.View1" xmlns:mvc="sap.ui.core.mvc" displayBlock="true" xmlns="sap.m">
	<Shell id="shell">
		<!--App is an aggregation of sap.m.Shell-->
		<App id="app">
			<pages>
				<!--Title, class, id defines properties-->
				<Page title="Page" class="sapUiContentPadding" id="page">
					<!--Content is an aggregation of sap.m.Page-->
					<content>
						<!--ariaDescribedBy is an association of sap.m.Button-->
						<!--text is a property of sap.m.Button-->
						<!--press is an event of sap.m.Button-->
						<Button text="Default" press="onPress" ariaDescribedBy="genericButtonDescription">
							<!--layoutData is an aggregation of sap.m.Button-->
							<layoutData>
								<FlexItemData growFactor="1"/>
							</layoutData>
						</Button>
						<!--id for sap.m.Label defines association for the sap.m.Button mentioned abouve-->
						<!--text is the property of sap.m.Label-->
						<Label id="genericButtonDescription" text="Association Example"/>
					</content>
				</Page>
			</pages>
		</App>
	</Shell>
</mvc:View>

I hope this blog boosts few SAP UIers and search in further to keep me posted with comments…

Thank you!! 🙂

#EnhanceLearning

BR//Dhanasupriya Sidagam

Assigned Tags

      4 Comments
      You must be Logged on to comment or reply to a post.
      Author's profile photo Krisha Engineer
      Krisha Engineer

      Thanks, this was helpful especially the chart of libraries! If you could elaborate and add if there are more libraries, that would be really helpful too!! 🙂

      Author's profile photo Dhanasupriya Sidagam
      Dhanasupriya Sidagam
      Blog Post Author

      Hello Krisha.. Thanks for the inputs.. Will post in further blogs.. ?

      Author's profile photo srikanth chimmili
      srikanth chimmili

      Hi supriya,

      Can you guide me how to use various methods related to classes like button..... with any example

      Author's profile photo Dhanasupriya Sidagam
      Dhanasupriya Sidagam
      Blog Post Author

      Sure