Seção API Reference no SAPUI5 SDK

Neste post, vou falar das bibliotecas, classes, construtores, propriedades, agregações, associações, eventos e métodos do SAP UI5. Em detalhes, eu vou falar sobre a seção 'referência da API', do SAP UI5 SDK: https://sapui5.hana.ondemand.com/#/api

UI5 SDK é a biblioteca com todas as regras e objetos do framework de programação UI5.

Abaixo está o esqueleto da estrutura do SAP UI5:




O fluxograma acima mostra como SAP UI5 SDK está organizado:
- No topo tem a biblioteca
- Abaixo tem os namespaces, que são os grandes grupos principais da biblioteca.  
- Dentro dos namespaces, os elementos de UI (botões, labels, etc) são disponibilizados como classes (orientação a objeto ein) , contendo propriedades e métodos.



Os desenvolvedores iniciantes do SAP UI5 vão acessar  o SAP UI5 SDK com frequência. No entanto, alguns podem não entender para que serve. Esta explicação pode dar suporte para aqueles que acabaram de entrar no mundo SAP UI5. 

Cada classe (elemento de UI) terá as seguintes abas:

Construtor: define o id e os parâmetros necessários para instanciar a classe de elemento de UI. O exemplo é JavaScript mas também é possível instanciar o objeto direto na tela do usuário (view  XML).

new sap.m.Button (sId, mSettings)

var oRadioButton = new RadioButton ("oControllerRadio", {
  text: "Funcionalidades",
  selected: true,
  tooltip: "Agregação de Radio Button"
}); 

Propriedades: mostra quais são os parametros que essa classe possui, e qual o valor default.

Agregações: essa tag indica quais elementos de UI filhos podem ser colocados dentro da classe. EXEMPLO: Uma tabela tem como agregação as colunas e as linhas, que são dois elementos de UI. Um ComboBox tem dentro dele os textos, que é outro elemento de UI.

Associações: Um controle pode ser manipulado com a ajuda de outro controle. A vantagem disso é que ambos podem ser criados e excluídos independentemente. Exemplo: um input que sugere resultados a medida que você digita texto. É difícil de entender no começo, tem que praticar um pouco mexer com diferentes elementos de UI pra entender, porque nem todos tem associações.

Eventos: Ajuda a criar uma reação para uma atividade na tela do usuário. Exemplo: um botão. Você pode clicar e soltar, clicar e manter clicado, ou só passar o mouse por cima dele. Cada tipo de ação gera um evento. Um input por exemplo, você pode digitar, apagar, e apertar enter.

Métodos: os métodos na sua maioria são métodos get & set, para obter ou definir as propriedades da classe definidas acima .

O exemplo abaixo é da API Reference no SAP UI5 SDK. Veja que tem comentários explicando as propriedades.

<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 above-->
      <!--text is the property of sap.m.Label-->
      <Label id="genericButtonDescription" text="Association Example"/>
     </content>
    </Page>
   </pages>
  </App>
 </Shell>
</mvc:View>

Espero que este blog melhore seu conhecimento. Me mantenha informado com comentários ...

Obrigado!! 🙂

Texto traduzido e adaptado, com adição de comentários pessoais do autor do blog. Original: tps://blogs.sap.com/2020/02/06/api-reference-of-sap-ui5-sdk/