03 The class TextFrame

See example 3

The TextFrame class is derived from ReportFrame and holds some kind of text. A TextFrame needs a text and a text style. It is a simple frame type with no other frames in it. You can add a text frame to any container frame using the addFrame function.

$report = new ReportLib\Report();
$body = $report->getBody();
$tsNormal = ReportLib\TextStyles::getTextStyle(ReportLib\TextStyles::NORMAL);
$tf = new ReportLib\TextFrame(“Text to print”, $ts);
$body->addFrame($tf);

The ReportLib tries to print the text into the given frame. If necessary, it inserts line breaks or even page breaks to fit the text into the report. The surrounding frame defines the width of the text. In the example the width is the printable area of the paper because the text is added to the main body frame of the report.

The text style controls the output of the text. But you can change the text color in this class by calling the function setTextColor.

By default, the library splits the text that does not fit into the given width of a frame into multiple lines, but you can define that the text should be cut off after one line. For that you have to set the wordWrap attribute to false.

The text may contain some variables which will be replaced during the output operation. You have to surround the variable names by square brackets. You can use:

  • VAR_PAGE – the page number
  • VAR_TOTAL_PAGES – the total number of pages in the document.

You can use these variables at any place, but they are often used in headers or footers.

$tsNormal = ReportLib\TextStyles::getTextStyle(ReportLib\TextStyles::NORMAL);
$tf = new ReportLib\TextFrame(“Page [VAR_PAGE] of [VAR_TOTAL_PAGES]”, $ts);

The renderer replaces the texts during the rendering, and it will keep the alignments correct. If you use the total number of pages, you have to inform the library to calculate the pages by calling setCountPages of your Report object.