Interface UILabelRenderer

All Superinterfaces:
UIRenderer

public interface UILabelRenderer extends UIRenderer
Interface for displaying a record in a table or a foreign key constraint.

Note: Inserting HTML code in labels may result in display issues for foreign key input fields, since the user interface includes measures to protect against cross-site scripting attempts.

Definition in the data model

A specific user interface label renderer component may be associated with any table to render its records. The component must be declared under the element <osd:table>, whether or not it is in association with standard <osd:defaultLabel> elements. For example:

 <xs:annotation>
   <xs:appinfo>
     <osd:table>
       <primaryKeys>/AssortmentID</primaryKeys>
       <defaultLabel>Assortment: ${./AssortmentID}</defaultLabel>
       <defaultLabel xml:lang="fr-FR">Assortiment: ${./AssortmentID}</defaultLabel>
       <defaultLabel xml:lang="en-US">Assortment: ${./AssortmentID}</defaultLabel>
       <defaultLabel osd:class="com.foo.AssortmentLabelRenderer"/>
     <osd:table>
   <xs:appinfo>
 </xs:annotation>
 
where com.foo.AssortmentLabelRenderer is the fully qualified name of a class implementing this interface.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Writes a user-friendly label to the specified context.
  • Method Details

    • displayLabel

      void displayLabel(UILabelRendererContext context)
      Writes a user-friendly label to the specified context.
      Multi-threading

      The implementation of this method must support the execution of multiple concurrent threads.