UI5-Komponente Metadaten

Question

Ich suche nach einem Dokument mit den möglichen Metadaten Eigenschaftsnamen und Konfigurationsparameter für eine Komponente.

Es gibt viele Dokumente im Internet mit einer solchen Definition. Die Frage ist, wie ich weiß, ob der Name einer Eigenschaft/Parametereinstellung ein gültiger Name ist.

metadata : { 
    name : "XXXXX", 
    version : "1.0", 
    includes : [], 
    dependencies : { 
     libs : ["sap.m", "sap.ui.layout"], 
     components : [] 
    }, 

    rootView : "XXXXX", 

    config : { 
     resourceName : "i18n", 
     resourceBundle : "XXXX", 
     serviceConfig : { 
      name : "main", 
      serviceUrl : "XXXXX", 
     } 
    } 

Answer 1

Es ist ein Dokument verfügbar here, das alle möglichen Metadaten beschreibt. Da es während der Entwurfszeit keine wirkliche Hilfe gibt, müssen Sie in die API schauen, um die möglichen Werte zu überprüfen. Wenn Sie es mit Ihren eigenen Eigenschaften/Parametern erweitern möchten, stellen Sie sicher, dass der Name nicht zu allgemein ist, da die Komponente mit jeder neuen Version von UI5 erweitert werden kann.

Answer 2

Die Component-Klasse erweitert die ManagedObject-Klasse und stellt spezifische Metadaten für Komponenten bereit. Die UIComponent-Klasse stellt zusätzliche Metadaten für die Konfiguration von Benutzeroberflächen oder die Navigation zwischen Ansichten bereit.

The metadata defined in component.js is common for faceless components and UI components. The following parameters are available: 

abstract: Specifies if your component class is an abstract class that serves as a base for other components 

version: Version of your component; this parameter belongs to the design-time metadata and is currently not used; it may be used in the future in the design-time repository 

includes: Array of strings containing the paths to CSS and JavaScript resources for your component; will be added to the header of the HTML page and loaded by the browser. The resources will be resolved relative to the location of Component.js. 

dependencies: Used to specify all external dependencies, such as libraries or components. Like the includes for resources that are added to the application’s HTML, the dependencies are loaded by SAPUI5 core before the component is initialized. Everything that is referenced here can be used in your component code right from the start. Specify here external dependences such as libraries or components, that will be loaded by SAPUI5 core in the initialization phase of your Component and can be used after it. 

libs: Path to the libraries that should be loaded by SAPUI5 core to be used in your component 

components: Full path to the components that should be loaded by SAPUI5 core to be used in your component 

ui5version: Minimum version of SAP UI5 that the component requires; it helps to be ensure that the features of SAPUI5 runtime used in this component are available. As SAPUI5 currently does not enforce the use of the correct version, it is only used for information purposes. 

properties: Defined for components in the same way as for a control or view 

library: Specify the library the component belongs to 

config: Static configuration; specify the name-value pairs that you need in the component 

customizing: Customizing for components and views, see Extending SAPUI5 Applications 

sap.ui.viewExtensions: Used for providing custom view content in a specified extension point in the standard application 

sap.ui.viewModifications: Used for overriding control properties in the standard application 

sap.ui.viewReplacements: Used for replacing a standard view with a custom view 

sap.ui.controllerExtensions: Used for replacing a standard controller with a custom controller 


for more Information go to the url: 
https://sapui5.netweaver.ondemand.com/sdk/#docs/guide/0187ea5e2eff4166b0453b9dcc8fc64f.html 

Answer 3

Wenn es sich um einen regulären Entwicklungsansatz handelt, sollten Sie idealerweise die API der Komponentenklasse betrachten.

Wenn Sie den metadatengesteuerten Ansatz für die Entwicklung verwenden und möglicherweise den erforderlichen Code generieren, sollten Sie Details aus den von der Klasse bereitgestellten Metadateninformationen abrufen oder aus der .js-Datei lesen. ".js" wird hilfreich sein, wenn Sie die SAPUI5-Laufzeit nicht verwenden.

Hoffe, das hilft.

.........
Good Luck

Answer 4

endgültige Antwort, indem Sie durch den Quellcode als nichts anderes zu sein hat, auch die API-Dokumentation, in der Lage sein zu 100% genau sein gegen die verbrauchende Quelle.

Answer 5

Nun, aus dem Code könnten Sie prüfen, ob die Eigenschaft mit der Methode get (Property Name) existiert, die alle Elemente haben. Sonst sind alle Eigenschaften ad hoc in dieser URL, die Tim Gerlach Ihnen zuvor mitgeteilt hat.

Answer 6

Der Ansatz zum Definieren von Komponentenmetadaten in der Komponente selbst wurde durch einen Ansatz ersetzt, der eine Manifestdatei verwendet. Sie finden alle verfügbaren Eigenschaften in der documentation.

Answer 7

Wie in der documentation erwähnt, wurde die Definition der Metadaten der Komponente weitgehend in eine separate Datei mit dem Namen manifest.json (aka Application Descriptor) verschoben.

Mit der Einführung des Deskriptors für Anwendungen, Komponenten und Bibliotheken empfehlen wir, die Komponentenmetadaten in den Deskriptor zu migrieren. [...] Weitere Informationen finden Sie unter Descriptor for Applications, Components, and Libraries.

---

Neben nur in der Liste der verfügbaren Parameter in dem doc suchen, in der Nähe „Hilfe“ erhalten Sie könnten, ist die Descriptor Editor von Web-IDE.

Der Descriptor Editor bietet verfügbare Optionen, Platzhalter Vorschläge und Eingabevalidierung.