Externe Typen in einem BIRT-Ereignishandler für das Berichtslayout

In diesem Abschnitt werden die externen EGL-Typen beschrieben, die Sie bei der Codierung eines Ereignishandlers für das Berichtslayout verwenden. Hintergrundinformationen finden Sie in den Abschnitten 'EGL-BIRT-Berichte', 'BIRT-Handler' und 'BIRT-Ereignishandler für das Berichtslayout'.

CellInstance

Eine Variable des Typs 'CellInstance' referenziert eine Zelle in einer Berichtstabelle oder einem Berichtsraster. Hintergrunddetail: Der Report Designer oder der Ereignishandler ermöglichen die Definition einer Zelle durch die Kombination von Spalten, Zeilen oder beidem.

Die Variable macht die folgenden Felder verfügbar:
  • columnNumber weist den Typ INT auf und enthält die Spaltennummer der Zelle, die erstellt wird.
  • columnSpan weist den Typ INT auf und enthält die Anzahl der Tabellen- oder Rasterspalten, die von der Zelle belegt werden.
  • rowSpan weist den Typ INT auf und enthält die Anzahl der Tabellen- oder Rasterzeilen, die von der Zelle belegt werden.

Die Funktionen und Felder, die im Abschnitt 'ReportElementInstance' beschrieben werden, sind ebenfalls verfügbar.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'CellInstance' verwendet wird:
function myFunction( myCell CellInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "myTable", rowNumber = 2 }
   if (myCell.columnNumber == 1)
      ;
   end
end

DataInstance

Eine Variable des Typs 'DataInstance' referenziert ein Berichtslayoutelement, das Daten aus einer Datenquelle oder aus einer Berechnung enthält. Die Variable macht das folgende Feld verfügbar:
  • value weist den Typ ANY auf und enthält den Wert des gebundenen Ausdrucks, der dem Element zugeordnet ist.

Die Felder und Funktionen, die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschrieben sind, sind ebenfalls verfügbar.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'DataInstance' verwendet wird:
function myFunction( myData DataInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "DepartmentName"}
   if (myData.value == "Sales")
      ;
   end 
end

DynamicTextInstance

Eine Variable des Typs 'DynamicTextInstance' referenziert ein Feld, das CLOB-Daten (CLOB = großes Zeichenobjekt) enthält, zum Beispiel ein Memo. Die Variable macht das folgende Feld verfügbar:
  • text weist den Typ STRING auf und enthält den Berichtstext.

Die Felder und Funktionen, die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschrieben sind, sind ebenfalls verfügbar.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'DynamicTextInstance' verwendet wird:
function myFunction( myText DynamicTextInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "resultOfEvaluation" }
   if (myText.text == "<b>Promote!</b>";
      ;
   end
end

GridInstance

Eine Variable des Typs 'GridInstance' referenziert ein Raster, d. h. eine einfache tabellenartige Struktur. Die einzigen verfügbaren Funktionen sind die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschriebenen Funktionen.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'GridInstance' verwendet wird:
function myFunction( myGridInstance GridInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "myGrid" }
   ;
end

ImageInstance

Eine Variable des Typs 'ImageInstance' referenziert ein Image, auf das über einen Verweis auf eine der folgenden Positionen zugegriffen wird:
  • Eine Web- oder Dateiadresse in Form eines URI (Uniform Resource Identifier), wie z. B. http://www.example.com/myImage.gif oder file:///c:/myImage.gif. In diesem Fall interpretiert der BIRT-Designer das Image als Typ 'URI'.
  • Ein Dateiname, wobei davon ausgegangen wird, dass sich die Datei im BIRT-Ressourcenordner befindet. (Sie erstellen einen Verweis auf diesen Ordner, indem Sie auf Windows -> Vorgaben ->Berichtsdesign -> Ressource klicken und dann den Ordner angeben.) In diesem Fall interpretiert der BIRT-Designer das Image als Typ 'Datei'.
  • Die Designdatei selbst. In diesem Fall interpretiert der BIRT-Designer das Image als Typ 'Eingebettet'.
  • Eine Spalte des Typs BLOB (großes Binärobjekt) in einem Dataset; in diesem Fall interpretiert der BIRT-Designer das Image als Typ 'Dynamisch'.

Wenn Sie im BIRT-Designer arbeiten, geben Sie den Typ des Images in der Anzeige für die Bearbeitung von Bildelementen an. In der BIRT-Dokumentation werden Images des Typs 'URI' und 'Datei' als verknüpfte Images bezeichnet.

Die Variable macht die folgenden Felder verfügbar:

  • altText weist den Typ STRING auf und enthält den Alternativtext; dieser Text wird angezeigt, wenn die Ausgabe im HTML-Format vorliegt und ein bestimmter Web-Browser das Image nicht anzeigen kann.
  • dynamicImageData weist den Typ BLOB auf und enthält den Inhalt eines Images vom Typ 'Dynamisch'.

    Die Getter-Methode und die Setter-Methode des Java-Codes lauten getData und setData.

  • embeddedImageName weist den Typ STRING auf und enthält den Namen eines Images vom Typ 'Eingebettet'. Dieser Name wird in der Berichtsdesigndatei angegeben und unterscheidet sich vom Elementnamen des Images.

    Die Getter-Methode und die Setter-Methode des Java-Codes lauten getImageName und setImageName.

  • imageURI weist den Typ STRING auf und enthält die Web- oder Dateiadresse, die auf ein Image des Typs 'URI' verweist.

    Die Getter-Methode und die Setter-Methode des Java-Codes lauten getURL und setURL.

  • linkedImageURI weist den Typ STRING auf und enthält die Web- oder Dateiadresse, die auf ein verknüpftes Image verweist (d. h. auf ein Image des Typs 'URI' oder 'Datei'). Dieser Variablen kann kein Wert zugewiesen werden.

    Die Getter-Methode des Java-Codes lautet getURI.

  • mimeType weist den Typ STRING auf und enthält den Typ des Speichermediums, z. B. 'image/gif', 'image/jpeg', 'image/png' und 'image/tiff'.

    Die Getter-Methode und die Setter-Methode des Java-Codes lauten getMimeType und setMimeType.

  • resourceFolderImageFile weist den Typ STRING auf und enthält den Namen eines Images des Typs 'Datei'.

    Die Getter-Methode und die Setter-Methode des Java-Codes lauten getFile und setFile.

Sie können den Ereignishandler verwenden, um den Verweis auf ein Image zu ändern, selbst wenn der im Ereignishandler angegebene Imagetyp nicht mit dem im Berichtsdesign angegebenen Imagetyp übereinstimmt. Der folgende Ereignishandler referenziert ein Image des Typs 'URI' und ist auch dann gültig, wenn im Design angegeben ist, dass der Typ des Images 'Eingebettet' lautet:
function changeImage( theImage ImageInstance, myContext ReportContext )  
   { eventType = onCreate, elementName = "salesGraphic" }
   theImage.imageURI == "file:///c:/images/myGraphic01.bmp";
end
Entsprechend referenziert der folgende Ereignishandler ein Image des Typs 'Eingebettet' und ist auch dann gültig, wenn das Design angibt, dass der Typ des Images 'URI' lautet:
function changeImage( theImage ImageInstance, myContext ReportContext )
   { eventType = onCreate, elementName = "salesGraphic02" }
   theImage.embeddedImageName = "myGraphic02.bmp";
end

LabelInstance

Eine Variable des Typs 'LabelInstance' referenziert eine Bezeichnung, d. h. Text, der keine HTML-Formatierung aufweist und keinen berechneten Wert wiedergibt. Die Variable macht das folgende Feld verfügbar:
  • text weist den Typ STRING auf und enthält den Bezeichnungstext.

Die Felder und Funktionen, die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschrieben sind, sind ebenfalls verfügbar.

Nachfolgend ist ein Beispiel für einen Ereignishandler dargestellt, der für ein Element des Typs 'LabelInstance' verwendet wird:
function myLabelFunction( theLabel LabelInstance, myContext ReportContext )  
   { eventType = onCreate, elementName = "remark_label" }
   balance float = theLabel.getRowData().getColumnValue("account_balance");
   if( balance > 0 )
      theLabel.text = "Balance Due";
      theLabel.getStyle().color = "red";
   end
end

ListInstance

Eine Variable des Typs 'ListInstance' referenziert eine Liste. Die einzigen verfügbaren Funktionen sind die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschriebenen Funktionen.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'ListInstance' verwendet wird:
function myFunction( myList ListInstance, myContext ReportContext )
    { eventType = onCreate, elementName = "employeeList" }
    ;
end

ReportContext

Ein Ereignishandlerparameter des Typs 'ReportContext' ermöglicht den Zugriff auf die Berichtsparameter. Es sind zwei Funktionen verfügbar:
  • setParameterValue legt den Wert eines Berichtsparameters fest, der anhand des Namens identifiziert wird:
     reportContext.setParameterValue
     ( parameterName STRING in, parameterValue ANY in ) 
  • Entsprechend ruft getParameterValue den Wert eines Berichtsparameters ab:
     reportContext.getParameterValue
     ( parameterName STRING in) returns (ANY)  

'ReportContext' ist kein Berichtslayoutelementtyp und nicht relevant für die Abschnitte zu 'ReportElementInstance' und 'ReportItemInstance'.

ReportElementInstance

Der Typ 'ReportElementInstance' entspricht einer Java™-Superklasse und ist allen anderen Berichtslayoutelementtypen übergeordnet, einschließlich den Typen 'CellInstance', 'RowInstance' und der Java-Superklasse 'ReportItemInstance'. Das Feld und die Funktionen, die in diesem Abschnitt beschrieben sind, sind für eine Variable eines beliebigen dieser Typen verfügbar.

Einige Felder und Funktionen greifen auf die folgenden CSS-Maßeinheiten (CSS = Cascading Style Sheet) zu: cm (Zentimeter), em (für eine bestimmte Schriftart erforderliche Höhe), ex (schriftartspezifische Höhe des Buchstabens x), in (Inch), mm (Millimeter), pc (Pica), % (Prozentsatz der Höhe des einschließenden Elements), pt (Punkt), px (Pixel). Hintergrunddetails finden Sie in http://www.w3.org/TR/CSS21/syndata.html.

Die Felder für 'ReportElementInstance' sind nachfolgend aufgeführt:
  • height weist den Typ STRING auf, enthält die Höhe des erstellten Elements sowie eine Maßeinheit (wie oben beschrieben). Die Zeichenfolge enthält keine Leerzeichen; Beispiel: '12pc'.
  • width weist den Typ STRING auf, enthält die Breite des erstellten Elements sowie eine Maßeinheit (wie oben beschrieben). Die Zeichenfolge enthält keine Leerzeichen; Beispiel: '12pc'.
Die Funktionen für 'ReportElementInstance' sind nachfolgend aufgeführt:
  • getParent gibt das übergeordnete Element zurück. Diese Funktion gibt ein Zellenelement zurück, z. B. wenn das im Aufruf verwendete Qualifikationsmerkmal auf ein Bezeichnungselement innerhalb der Zelle verweist.
    element.getParent()returns (ReportElementInstance)
    Wie dargestellt, gibt die Funktion ein Element des Typs 'ReportElementInstance' zurück. Wenn die Funktion ein Element des Typs 'CellInstance' zurückgibt und Sie auf das Feld 'columnNumber' in diesem Element zugreifen möchten, müssen Sie den zurückgegebenen Wert mithilfe eines Umsetzungsausdrucks konvertieren. Beispiel:
    function myLabelFunction( theLabel LabelInstance, myContext ReportContext  ) 
       { eventType = onCreate, elementName = "remark_label" }
       myReportInstance ReportElementInstance = theLabel.getParent();
       if (myReportInstance isa CellInstance )
          myCellInstance CellInstance = 
             myReportElementInstance as CellInstance;
          if (myCellInstance.columnNumber == 1)
             ;
          end
      end
    end
  • getRowData gibt ein Objekt des Typs 'RowData' zurück. Das zurückgegebene Objekt enthält eine Gruppe von Spaltenbindungen, die im BIRT Report Designer in der Eigenschafteneditoransicht für den Bericht aufgeführt sind. (Die Bindungen sind auf der entsprechenden Registerkarte dieser Ansicht aufgelistet.) Mit dem Objekt können Sie die Funktion 'getColumnValue' aufrufen, die den Wert einer bestimmten Spaltenbindung abruft. Details zu dieser Funktion finden Sie im Abschnitt zu 'RowData'.
    element.getRowData() returns (RowData)
  • getStyle gibt ein Objekt des Typs 'Style' zurück, das die Werte enthält, die den verwendeten CSS-Stil darstellen. Details zum Zugriff auf diese Werte finden Sie im Abschnitt zu 'Style'.
    element.getStyle() returns (Style)
  • getNamedExpressionValue gibt den Wert des angegebenen benannten Ausdrucks zurück. Die benannten Ausdrücke sind im BIRT Report Designer in der Eigenschafteneditoransicht für den Bericht aufgeführt.
    element.getNamedExpressionValue 
         (expressionName STRING in) returns (ANY)
    Mit dieser Funktion können Sie auf JavaScript-Ausdrücke zugreifen, die im Berichtsdesign definiert sind. So können Sie beispielsweise für eine Bezeichnung mit dem Namen total einen Ausdruck mit dem Namen BalanceTotal als Total.sum(row["account_balance"]) definieren; und im Ereignis 'onCreate' können Sie den Bezeichnungstext wie folgt festlegen:
    function onTotalLabel( l LabelInstance, c ReportContext )
       { eventType = onCreate, elementName = "total" }
       l.text = "Total balance = " + l.getNamedExpressionValue("BalanceTotal");
    end

ReportItemInstance

Der Typ 'ReportItemInstance' entspricht einer Java-Superklasse und ist 'ReportElementInstance' untergeordnet. Das folgende Feld wird durch eine Variable verfügbar gemacht, die einen Berichtslayoutelementtyp aufweist, bei dem es sich nicht um 'CellInstance', 'RowInstance' oder 'ReportElementInstance' handelt:
  • helpText weist den Typ STRING auf und enthält den Hilfetext zum Element.

RowData

'RowData' ist kein Berichtslayoutelementtyp wie 'LabelInstance', und kein Ereignishandler verwendet einen Parameter des Typs 'RowData'. Stattdessen wird ein Objekt des Typs 'RowData' zurückgegeben, wenn 'element.getRowData()' aufgerufen wird. Eine Beschreibung hierzu finden Sie im Abschnitt zu 'ReportElementInstance'.

Die Funktionen für 'RowData' sind nachfolgend aufgeführt:
  • getColumnCount gibt die Anzahl der Spaltenbindungen zurück:
      element.getRowData().getColumnCount() returns (INT)
  • getColumnName gibt den Namen einer Spaltenbindung zurück, die durch eine Indexnummer identifiziert wird:
      element.getRowData().getColumnName( columnNumber INT in )returns (STRING)

    Die erste Spalte weist die Nummer 1 auf, nicht 0.

  • Eine Form von getColumnValue gibt den Wert einer Spaltenbindung zurück, die anhand des Namens identifiziert wird:
      element.getRowData().getColumnValue( columnName STRING in )returns (ANY)
  • Eine zweite Form von getColumnValue gibt den Wert einer Spaltenbindung zurück, die anhand einer Indexnummer identifiziert wird:
      element.getRowData().getColumnValue( columnNumber INT in ) returns (ANY)

    Die erste Spalte weist die Nummer 1 auf, nicht 0.

RowInstance

Eine Variable des Typs 'RowInstance' referenziert eine Zeile in einer Berichtstabelle. Die einzigen verfügbaren Funktionen sind die im Abschnitt 'ReportElementInstance' beschriebenen Funktionen.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'RowInstance' verwendet wird:
function myFunction( myRow RowInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "myTable", rowType = detail, rowNumber = 2 }
   ;
end

Darstellung

'Style' ist kein Berichtslayoutelementtyp wie 'LabelInstance', und kein Ereignishandler verwendet einen Parameter des Typs 'Style'. Stattdessen wird ein Objekt des Typs 'Style' zurückgegeben, wenn 'element.getStyle()' aufgerufen wird. Eine Beschreibung hierzu finden Sie im Abschnitt zu 'ReportElementInstance'.

Nachdem Sie das Objekt erhalten haben, können Sie auf einen der 'Style'-Werte zugreifen, indem Sie einen Java-Feldnamen referenzieren. In jedem Fall weist das Feld den Typ STRING auf. Beispiel: Sie können die Hintergrundfarbe für das Element myElement wie folgt festlegen:
   myElement.getStyle().backgroundColor = "red";
Entsprechend können Sie die Hintergrundfarbe in eine Variable des Typs STRING abrufen:
   myColor STRING;
   myColor = myElement.getStyle().backgroundColor;

Wie in der folgenden Tabelle dargestellt kann auf viele Java-Felder auf diese Weise zugegriffen werden.

Feldname Bedeutung
backgroundAttachment Gibt an, ob ein Hintergrundimage beim Blättern zusammen mit dem Rest der Seite verschoben wird oder fixiert bleibt. Der Wert lautet 'scroll' (Standardwert) oder 'fixed'.
backgroundColor Die Hintergrundfarbe des Elements.
backgroundImage Die Web- oder Dateiadresse des Hintergrundimages.
backgroundPositionX Die horizontale Position des Hintergrundimages: 'center', 'left', 'right' oder eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
backgroundPositionY Die vertikale Position des Hintergrundimages: 'center', 'top', 'bottom' oder eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
backgroundRepeat Gibt an, ob ein Hintergrundimage wiederholt wird: 'repeat' (Standardwert: horizontal und vertikal auf der Seite wiederholen), 'no-repeat' (keine Wiederholung), 'repeat-x' (horizontal auf der Seite wiederholen) oder 'repeat-y' (vertikal auf der Seite wiederholen).
borderBottomColor Die Farbe der Umrandung ganz unten. Eine Farbe ist nur verfügbar, wenn 'borderBottomStyle' festgelegt ist.
borderBottomStyle Ein Wert (falls zutreffend) zur Beschreibung der Umrandung ganz unten: 'solid' (durchgezogen), 'dotted' (gepunktet), 'dashed' (gestrichelt), 'double' (doppelt).
borderBottomWidth Die Breite der Umrandung ganz unten: 'thin', 'medium', 'thick'. Eine Breite ist nur verfügbar, wenn 'borderBottomStyle' festgelegt ist.
borderLeftColor Die Farbe der Umrandung ganz links. Eine Farbe ist nur verfügbar, wenn 'borderLeftStyle' festgelegt ist.
borderLeftStyle Ein Wert (falls zutreffend) zur Beschreibung der Umrandung ganz links: 'solid' (durchgezogen), 'dotted' (gepunktet), 'dashed' (gestrichelt), 'double' (doppelt).
borderLeftWidth Die Breite der Umrandung ganz links: 'thin', 'medium', 'thick'. Eine Breite ist nur verfügbar, wenn 'borderLeftStyle' festgelegt ist.
borderRightColor Die Farbe der Umrandung ganz rechts. Eine Farbe ist nur verfügbar, wenn 'borderRightStyle' festgelegt ist.
borderRightStyle Ein Wert (falls zutreffend) zur Beschreibung der Umrandung ganz rechts: 'solid' (durchgezogen), 'dotted' (gepunktet), 'dashed' (gestrichelt), 'double' (doppelt).
borderRightWidth Die Breite der Umrandung ganz rechts: 'thin', 'medium', 'thick'. Eine Breite ist nur verfügbar, wenn 'borderRightStyle' festgelegt ist.
borderTopColor Die Farbe der Umrandung ganz oben. Eine Farbe ist nur verfügbar, wenn 'borderTopStyle' festgelegt ist.
borderTopStyle Ein Wert (falls zutreffend) zur Beschreibung der Umrandung ganz oben: 'solid' (durchgezogen), 'dotted' (gepunktet), 'dashed' (gestrichelt), 'double' (doppelt).
borderTopWidth Die Breite der Umrandung ganz oben: 'thin', 'medium', 'thick'. Eine Breite ist nur verfügbar, wenn 'borderTopStyle' festgelegt ist.
canShrink Gibt an, ob der Textbereich in der HTML-Ausgabe verkleinert werden soll, wenn der Inhalt nicht den gesamten Bereich benötigt: 'false' (Standardwert) oder 'true'.
color Die Vordergrundfarbe des Elements.
dateFormat Eines der durch BIRT definierten Standarddatumsformate:
  • 'General Date', z. B. 'October 20, 1998 12:00:00 AM CDT'
  • 'Long Date', z. B. 'October 20, 1998'
  • 'Medium Date', z. B. 'Oct 20, 1998'
  • 'Short Date', z. B. '10/7/98'
  • 'Long Time', z. B. '12:00:00 AM CDT'
  • 'Medium Time', z. B. '12:00:00 AM'
  • 'Short Time', z. B. '24:00'

BIRT ermöglicht es dem Report Designer darüber hinaus, ein benutzerdefiniertes Format auf der Basis eines Musters festzulegen, das von der Java-Klasse 'SimpleDateFormat' unterstützt wird. Beispielsweise kann das Format 'M/d/yyyy, E' verwendet werden, mit dem das aktuelle Beispiel als '10/20/1998 Tues' angezeigt wird.

displayType Gibt an, ob das Element in einem separaten Textblock, in der aktuellen Zeile innerhalb des aktuellen Textblocks oder gar nicht angezeigt wird. Die Werte lauten 'block' (Standardwert), 'inline' und 'none'. Die EGL-Eigenschaft displayType entspricht der zugrunde liegenden Java-spezifischen Eigenschaft display.
fontFamily Die Schriftartengruppe: 'serif' (Standardwert), 'sans-serif', 'cursive', 'fantasy', 'monospace' usw.
fontSize Die Schriftgröße des Texts. Eine der durch BIRT definierten Standardgrößen: 'medium' (Standardwert), 'large', 'larger' 'small', 'smaller', 'x-large', 'x-small', 'xx-large' oder 'xx-small'. Alternativ dazu kann der Wert eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit sein, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
fontStyle Der Schriftstil des Texts: 'normal' (Standardwert), 'italic' oder 'oblique'.
fontVariant Die Schriftvariante: 'normal' (Standardwert) oder 'small-caps'.
fontWeight Die Schriftstärke des Texts: 'normal', 'bold', 'bolder', 'lighter' oder ein Hunderterwert von 100 bis 900.
letterSpacing Das Leerzeichen zwischen den Buchstaben. Der Standardwert lautet 'normal' (der Wert ist für die jeweilige Schriftart spezifisch). Alternativ dazu kann der Wert eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit sein, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
lineHeight Die Zeilenhöhe: Der Standardwert lautet 'normal' (der Wert ist für die jeweilige Schriftart spezifisch). Alternativ dazu kann der Wert eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit sein, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
marginBottom Der Abstand zwischen der untersten Linie der Umrandung und dem nächsten horizontalen Element. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
marginLeft Der Abstand zwischen der ganz linken Linie der Umrandung und dem vorhergehenden vertikalen Element. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
marginRight Der Abstand zwischen der ganz rechten Linie der Umrandung und dem nächsten vertikalen Element. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
marginTop Der Abstand zwischen der obersten Linie der Umrandung und dem vorhergehenden horizontalen Element. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
masterPage Eine Zeichenfolge, die die Masterseite identifiziert.
numberFormat Eines der durch BIRT definierten Zahlenformate: Beispiele: 'General Number', 'Fixed', 'Percent' und 'Scientific'. BIRT ermöglicht es dem Report Designer darüber hinaus, ein benutzerdefiniertes Format auf der Basis eines Musters festzulegen, das von der Java-Klasse 'DecimalFormat' unterstützt wird. Beispielsweise kann das Zahlenformat '$#,##0.00' verwendet werden, durch das die Zahl 123456 als $1,234.56 angezeigt wird.
paddingBottom Abstand zwischen dem Inhalt eines Elements und der untersten Linie in der Umrandung des Elements. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
paddingLeft Abstand zwischen dem Inhalt eines Elements und der ganz linken Linie in der Umrandung des Elements. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
paddingRight Abstand zwischen dem Inhalt eines Elements und der ganz rechten Linie in der Umrandung des Elements. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
paddingTop Abstand zwischen dem Inhalt eines Elements und der obersten Linie in der Umrandung des Elements. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
pageBreakAfter Gibt die Bedingung an, unter der ein nachfolgender Seitenumbruch stattfindet: 'auto' (Standardwert, d. h. der Seitenumbruch findet automatisch statt, um andere Anforderungen hinsichtlich des Platzbedarfs zu erfüllen), 'always', 'avoid', 'always-excluding-first', 'always-excluding-last'.
pageBreakBefore Gibt die Bedingung an, unter der ein Seitenumbruch unmittelbar vor dem Element stattfindet: 'auto' (Standardwert, d. h. der Seitenumbruch findet automatisch statt, um andere Anforderungen hinsichtlich des Platzbedarfs zu erfüllen), 'always', 'avoid', 'always-excluding-first', 'always-excluding-last'.
pageBreakInside Gibt die Bedingung an, unter der ein Seitenumbruch innerhalb des Elements stattfindet: 'auto' (Standardwert, d. h. der Seitenumbruch findet automatisch statt, um andere Anforderungen hinsichtlich des Platzbedarfs zu erfüllen), 'avoid'.
showIfBlank Gibt an, ob ein Element angezeigt werden soll, auch wenn es leer ist oder wenn alle untergeordneten Elemente leer sind: 'false' (Standardwert), 'true'.
stringFormat Eine Formatierzeichenfolge basierend auf einem durch BIRT definierten System von Symbole wie z. B. @ & | > <.
textAlign Einer der Werte für die horizontale Ausrichtung: 'left', 'right', 'center', 'justify'.
textIndent Die Einrückung des Texts innerhalb des Elements. Die Zeichenfolge enthält keine Leerzeichen und beinhaltet eine Maßeinheit; z. B. '12pc'. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.
textTransform Gibt an, wie der Text geändert werden soll, der in das Element eingefügt wird: 'none' (Standardwert: keine Änderung), 'capitalize' (den ersten Buchstaben jedes Wortes in Großbuchstaben umsetzen), 'uppercase' (alle Buchstaben in Großbuchstaben umsetzen), 'lowercase' (alle Buchstaben in Kleinbuchstaben umsetzen).
verticalAlign Einer der Werte für die vertikale Ausrichtung: 'top', 'middle', 'bottom'.
visibleFormat Gibt an, ob das Element ausgeblendet wird, wenn die Berichtsausgabe ein bestimmtes Format aufweist: 'all', 'pdf', 'html'.
whiteSpace Gibt für die HTML-Ausgabe an, wie mit Leerzeichen im Elementtext verfahren werden soll: 'normal' (Standardwert: überzählige Leerzeichen entfernen und bei Bedarf Zeilenumbrüche einfügen, um den Text der Elementbreite anzupassen), 'pre' (Leerzeichen im Elementtext beibehalten, einschließlich der Zeilenumbrüche), 'nowrap' (überzählige Leerzeichen entfernen, ohne Zeilenumbrüche einzufügen). Das jeweilige Verhalten kann je nach Browsertyp und -version variieren.
wordSpacing Der Abstand zwischen Wörtern. Der Standardwert lautet 'normal' (der Wert ist für die jeweilige Schriftart spezifisch). Alternativ dazu kann der Wert eine Zeichenfolge bestehend aus einer Zahl und einer Maßeinheit sein, z. B. '12pc'. Die Zeichenfolge enthält keine Leerzeichen. Weitere Details zu Maßeinheiten finden Sie im Abschnitt zu 'ReportElementInstance'.

TableInstance

Eine Variable des Typs 'TableInstance' referenziert eine Berichtstabelle. Die einzigen verfügbaren Funktionen sind die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschriebenen Funktionen. Die Variable macht die folgenden Felder verfügbar:
  • caption weist den Typ STRING auf und enthält die Tabellenbeschriftung.
  • repeatHeader weist den Typ BOOLEAN auf und gibt an, ob die Tabellenüberschriften auf den Seiten nach der ersten Seite wiederholt werden sollen. Gültige Werte sind 'true' (Standardwert) und 'false'.
Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'TableInstance' verwendet wird:
function myFunction( myTable TableInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "myTable" }
   ;
end

TextInstance

Eine Variable des Typs 'TextInstance' referenziert Berichtstext, der HTML-Format aufweisen oder einen berechneten Wert darstellen kann. Die Variable macht das folgende Feld verfügbar:
  • text weist den Typ STRING auf und enthält den Berichtstext.

Die Felder und Funktionen, die in den Abschnitten 'ReportElementInstance' und 'ReportItemInstance' beschrieben sind, sind ebenfalls verfügbar.

Nachfolgend ist ein Entwurf für einen Ereignishandler dargestellt, der für ein Element des Typs 'TextInstance' verwendet wird:
function myFunction( myText TextInstance, myContext ReportContext ) 
   { eventType = onCreate, elementName = "conclusion" }
   if (myText.text == "<b>Promote!</b>";
      ;
   end
end

Feedback