定义 UI 注解
ABAP RESTful 应用程序编程模型 › 启动 › 为简单列表报告开发 OData 服务 › 设计 Fiori 元素应用的用户界面 › 定义 UI 注释
在 CDS 中使用注释配置 SAP Fiori 元素用户界面中 CDS 元素的演示和顺序。
上下文
您已创建 OData 服务并在本地发布。现在,可以使用 CDS 层中的 UI 注释设置 UI,以定义独立于应用程序或用户设备的 UI 布局。您始终可以通过使用服务绑定部件中的预览功能来检查 UI 注释的影响。
列表项目
上下文
使用以下注释,您可以指定启动应用时哪些元素显示在列表报表中。除顺序外,如果要使用 CDS 实体中指定的名称以外的名称显示它们,还可以对其进行重命名。UI 中显示的列随即预定义,您可以通过选择执行来检索数据,而无需确定要显示的列。
过程
打开要确定清单报表的 CDS 视图。在我们的案例中: /DMO/I_Connection_R。
对于列表的标题,使用注释
@UI.headerInfo.typeNamePlural:'name'。此注释是实体注释,因为它涉及整个实体而不是特定元素。
@AccessControl.authorizationCheck: #NOT_REQUIRED @EndUserText.label: 'Read-Only E2E: Data Model Connection' @UI.headerInfo.typeNamePlural: 'Connections' define view entity /DMO/I_Connection_R …
使用注释
@UI.lineItem: [ { position:decfloat } ]为要在列表报表中显示的每个元素指定位置。备注
值的数字不代表绝对度量,而是用作其他元素位置的相对值。因此,元素在注释值方面按升序排列。
… define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection { @UI.lineItem: [ { position: 10 } ] key Connection.carrier_id as AirlineID, @UI.lineItem: [ { position: 20 } ] key Connection.connection_id as ConnectionID, @UI.lineItem: [ { position: 30 } ] Connection.airport_from_id as DepartureAirport, @UI.lineItem: [ { position: 40 } ] Connection.airport_to_id as DestinationAirport, @UI.lineItem: [ { position: 50 } ] Connection.departure_time as DepartureTime, @UI.lineItem: [ { position: 60 } ] Connection.arrival_time as ArrivalTime, @Semantics.quantity.unitOfMeasure: 'DistanceUnit' Connection.distance as Distance, //** secondary information, not to be displayed on list report entry page Connection.distance_unit as DistanceUnit //** secondary information, not to be displayed on list report entry page }
通过使用注释
@UI.lineItem.label: label标记元素,可以显示名称不是 CDS 中指定的名称的元素。特别是,可以使用包含空格的名称标记元素。标签显示在清单报表的列标题中。… define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection { @UI.lineItem: [ { position: 10, label: 'Airline'} ] key Connection.carrier_id as AirlineID, @UI.lineItem: [ { position: 20, label:'Connection Number' } ] key Connection.connection_id as ConnectionID, @UI.lineItem: [ { position: 30 , label: 'Departure Airport Code'} ] Connection.airport_from_id as DepartureAirport, @UI.lineItem: [ { position: 40 , label: 'Destination Airport Code'} ] Connection.airport_to_id as DestinationAirport, @UI.lineItem: [ { position: 50 , label: 'Departure Time'} ] Connection.departure_time as DepartureTime, @UI.lineItem: [ { position: 60 , label: 'Arrival Time' } ] Connection.arrival_time as ArrivalTime, @Semantics.quantity.unitOfMeasure: 'DistanceUnit' Connection.distance as Distance, //** secondary information, not to be displayed on list report entry page Connection.distance_unit as DistanceUnit //** secondary information, not to be displayed on list report entry page }
结果
源代码指定清单报表中显示 CDS 视图 /DMO/I_Connection_R 的哪些元素以及显示顺序。此外,列表报表的标题为连接。启动应用时,不必在设置中选择列,因为它们已显示。按“执行”按钮检索数据。

清单报表抬头
上下文
以下注释指定列表报表抬头中显示的项目。
您可以定义清单报表的抬头,也可以在清单报表顶部实施选择字段以过滤特定项目。一个选择字段始终引用一个元素,但在单个列表报表头中可以有多个选择字段。
过程
要在标头中包含关键元素的选择字段,请在相应元素上使用注释 @UI.selectionField.position:decfloat。
备注
值的数字不代表绝对度量,而是用作其他选择字段位置的相对值。因此,选择字段根据注释值按升序排列。
…
@UI.lineItem: [ { position: 30 , label: 'Departure Airport Code'} ]
@UI.selectionField: [ { position: 10 } ]
Connection.airport_from_id as DepartureAirport,
@UI.lineItem: [ { position: 40 , label: 'Destination Airport Code'} ]
@UI.selectionField: [ { position: 20 } ]
Connection.airport_to_id as DestinationAirport,
…
结果
选择字段注释用于 CDS 视图的关键元素,以在列表报表的抬头中创建选择字段。使用这些选择字段,您可以过滤特定清单项目。

对象页面
上下文
清单报表提供清单项目的常规概览,而对象页面显示有关单个清单项目的更多详细信息。通过单击列表报表中的项目导航到对象页面。
过程
/DMO/I_Connection_R(使用注释
@UI.headerInfo.typeName: 'name')。@AccessControl.authorizationCheck: #NOT_REQUIRED @EndUserText.label: 'Read-Only E2E: Data Model Flight' @UI.headerInfo.typeName: 'Connection' define view /DMO/I_Connection_R ...
使用注释
@UI.facet.purpose: #STANDARD为对象页面创建标准构面。此注释必须在元素部分中。构面是对象页面中的部分类型。可以在用户界面的离散部分中包含图或其他信息。
define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection { @UI.facet: [ { purpose: #STANDARD } ] ...
指定构面的类型。在我们的案例中,对象页面显示一个列表项目的详细信息。使用注释
@UI.facet.type: #IDENTIFICATION_REFERENCE。define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection{ @UI.facet: [ { purpose: #STANDARD, type: #IDENTIFICATION_REFERENCE } ] …
指定对象页面构面抬头的名称。使用注释
@UI.facet.label: 'name'。define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection { @UI.facet: [ { purpose: #STANDARD, type: #IDENTIFICATION_REFERENCE, label: 'Connection' } ] …
要定义构面的位置,请使用注释
@UI.facet.position: decfloat。define view entity /DMO/I_Connection_R as select from /dmo/connection as Connection{ @UI.facet: [ { purpose: #STANDARD, type: #IDENTIFICATION_REFERENCE, label: 'Connection', position: 10 } ] …
创建类型标识参考的对象页面。现在,您可以定义在对象页面中显示的元素。
指定要在对象页面中显示的每个元素的位置和标签。在每个元素上使用注释
@UI.identification.position: 'decfloat'和@UI.identification.label: 'name'。{ … @UI: { identification:[ { position: 10, label: 'Airline' } ] } key Connection.carrier_id as AirlineID, @UI: { identification:[ { position: 20, label: 'Connection Number' } ] } key Connection.connection_id as ConnectionID, @UI: { identification:[ { position: 30, label: 'Departure Airport Code'} ] } @UI.selectionField: [ { position: 10 } ] Connection.airport_from_id as DepartureAirport, @UI: { identification:[ { position: 40, label: 'Destination Airport Code'} ] } @UI.selectionField: [ { position: 20 } ] Connection.airport_to_id as DestinationAirport, @UI: { identification:[ { position: 50, label: 'Departure Time' } ] } Connection.departure_time as DepartureTime, @UI: { identification:[ { position: 60, label: 'Arrival Time' } ] } Connection.arrival_time as ArrivalTime, @Semantics.quantity.unitOfMeasure: 'DistanceUnit' @UI: { identification:[ { position: 70, label: 'Distance' } ] } Connection.distance as Distance, //** secondary information, not to be displayed on list report entry page Connection.distance_unit as DistanceUnit //** secondary information, not to be displayed on list report entry page }
下图显示了单击连接项目 JL 407 后的对象页面。

激活 CDS 视图。
结果
生成的源代码(包括数据定义中与 UI 相关的所有注释)如下所示:
展开以下代码示例以查看源代码
示例代码
@AccessControl.authorizationCheck: #NOT_REQUIRED
@EndUserText.label: 'Read-Only E2E: Data Model Connection'
@UI.headerInfo: { typeName: 'Connection',
typeNamePlural: 'Connections' }
define view entity /DMO/I_Connection_R
as select from /dmo/connection as Connection
{ @UI.facet: [
{ id: 'Connection',
purpose: #STANDARD, }
type: #IDENTIFICATION_REFERENCE,
label: 'Connection' } ]
@UI.lineItem: [ { position: 10, label: 'Airline'} ]
@UI: { identification:[ { position: 10, label: 'Airline' } ] }
key Connection.carrier_id as AirlineID,
@UI.lineItem: [ { position: 20, label:'Connection Number' } ]
@UI: { identification:[ { position: 20, label: 'Connection Number' } ] }
key Connection.connection_id as ConnectionID,
@UI: { identification:[ { position: 30, label: 'Departure Airport Code'} ]
@UI.lineItem: [ { position: 40 , label: 'Destination Airport Code'} ]
@UI.selectionField: [ { position: 10 } ]
Connection.airport_from_id as DepartureAirport,
@UI.lineItem: [ { position: 40 , label: 'Destination Airport Code'} ]
@UI: { identification:[ { position: 40, label: 'Destination Airport Code'} ] }
@UI.selectionField: [ { position: 20 } ] }
Connection.airport_to_id as DestinationAirport,
@UI.lineItem: [ { position: 50 , label: 'Departure Time'} ]
@UI: { identification:[ { position: 50, label: 'Departure Time' } ] }
Connection.departure_time as DepartureTime,
@UI.lineItem: [ { position: 60 , label: 'Arrival Time' } ]
@UI: { identification:[ { position: 60, label: 'Arrival Time' } ] }
Connection.arrival_time as ArrivalTime,
@Semantics.quantity.unitOfMeasure: 'DistanceUnit'
@UI: { identification:[ { position: 70, label: 'Distance' } ] }
Connection.distance as Distance, //** secondary information, not to be displayed on list report entry page
Connection.distance_unit as DistanceUnit //** information is given with element Distance via semantic connection
}