Package pi.graphics.boxes

Class TextBlockBox

java.lang.Object
pi.graphics.boxes.Box
pi.graphics.boxes.LeafBox
pi.graphics.boxes.TextBox
pi.graphics.boxes.TextBlockBox
All Implemented Interfaces:
Iterable<Box>
public class TextBlockBox extends TextBox
Ein mehrzeiliger Textblock.
Since:
0.41.0
Author:
Josef Friedrich

  • Constructor Details

    • TextBlockBox

      public TextBlockBox(Object... content)
      Erzeugt einen mehrzeiligen Textblock.
      Parameters:
      content - Der Inhalt des Textblocks. Es können mehrere Eingabewerte angegeben werden. Jeder Eingabewert wird in eine eigene Zeile gesetzt.
      Since:
      0.41.0

  • Method Details

    • content

      public TextBlockBox content(Object... content)
      Setzt den Inhalt des Textblocks.
      Parameters:
      content - Der Inhalt des Textblocks. Es können mehrere Eingabewerte angegeben werden. Jeder Eingabewert wird in eine eigene Zeile gesetzt.
      Returns:
      Eine Referenz auf die eigene Instanz der Box, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften der Box durch aneinander gekettete Setter festgelegt werden können, z.B. box.x(..).y(..).
      Since:
      0.45.0

    • width

      @API @Setter @ChainableMethod public TextBlockBox width(int width)
      Setzt die Breite des Textblocks.
      Overrides:
      width in class Box
      Parameters:
      width - Die Breite des Textblocks in Pixeln.
      Returns:
      Eine Referenz auf die eigene Instanz der Box, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften der Box durch aneinander gekettete Setter festgelegt werden können, z.B. box.x(..).y(..).

    • charsPerLine

      @API @Getter public int charsPerLine()
      Gibt die maximale Zeichenbreite pro Zeile des Textblocks.
      Returns:
      Die maximale Zeichenbreite pro Zeile.

    • charsPerLine

      @API @Setter @ChainableMethod public TextBlockBox charsPerLine(int charsPerLine)
      Setzt die maximale Zeichenbreite pro Zeile des Textblocks.
      Parameters:
      charsPerLine - Die maximale Zeichenbreite pro Zeile.
      Returns:
      Eine Referenz auf die eigene Instanz der Box, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften der Box durch aneinander gekettete Setter festgelegt werden können, z.B. box.x(..).y(..).

    • hAlign

      @API @Getter public HAlign hAlign()
      Gibt die horizontale Ausrichtung der einzelnen Textzeilen.
      Returns:
      Die horizontale Ausrichtung.

    • hAlign

      @API @Setter @ChainableMethod public TextBlockBox hAlign(HAlign hAlign)
      Setzt die horizontale Ausrichtung der einzelnen Textzeilen.
      Parameters:
      hAlign - Die gewünschte horizontale Ausrichtung.
      Returns:
      Eine Referenz auf die eigene Instanz der Box, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften der Box durch aneinander gekettete Setter festgelegt werden können, z.B. box.x(..).y(..).

    • lineSpacing

      @API @Getter public double lineSpacing()
      Gibt den Zeilenabstand.

      Der Zeilenabstand ist ein Faktor, der den Abstand zwischen den Zeilen relativ zum Standardabstand bestimmt. Ein Wert von 1 bedeutet den normalen Zeilenabstand, Werte größer als 1 erhöhen den Abstand, während Werte zwischen 0 und 1 den Abstand verringern. Zum Beispiel würde ein Wert von 1.5 den Zeilenabstand um 50% erhöhen, während ein Wert von 0.75 den Zeilenabstand um 25% verringern würde.

      Returns:
      Der Zeilenabstand.

    • lineSpacing

      @API @Setter @ChainableMethod public TextBlockBox lineSpacing(double lineSpacing)
      Setzt den Zeilenabstand.

      Der Zeilenabstand ist ein Faktor, der den Abstand zwischen den Zeilen relativ zum Standardabstand bestimmt. Ein Wert von 1 bedeutet den normalen Zeilenabstand, Werte größer als 1 erhöhen den Abstand, während Werte zwischen 0 und 1 den Abstand verringern. Zum Beispiel würde ein Wert von 1.5 den Zeilenabstand um 50% erhöhen, während ein Wert von 0.75 den Zeilenabstand um 25% verringern würde.

      Parameters:
      lineSpacing - Der Zeilenabstand.
      Returns:
      Eine Referenz auf die eigene Instanz der Box, damit nach dem Erbauer/Builder-Entwurfsmuster die Eigenschaften der Box durch aneinander gekettete Setter festgelegt werden können, z.B. box.x(..).y(..).

    • lines

      @API @Getter public List<TextBlockBox.TextLayoutLine> lines()
      Gibt die intern berechneten, umgebrochenen Textzeilen zurück.
      Returns:
      Eine Liste aus Layout-/Text-Paaren je Zeile.
      Since:
      0.45.0

    • linesText

      @API public String[] linesText()
      Gibt den Textinhalt der einzelnen Zeilen zurück.
      Returns:
      Jede Zeile ist ein Element des Arrays.
      Since:
      0.45.0

    • linesCount

      @API public int linesCount()
      Gibt die Anzahl der Zeilen in diesem Textblock zurück.
      Returns:
      Die Anzahl der Zeilen.
      Since:
      0.45.0

    • calculateDimension

      protected void calculateDimension()
      Description copied from class: Box
      Berechnet rekursiv die Abmessung (die Höhe und Breite) der eigenen Box.

      Single-Child-Code-Beispiel

       
 protected void calculateDimension()
 {
     width = child.width + 2 * margin;
     height = child.height + 2 * margin;
 }

      Multiple-Child-Code-Beispiel

       
 protected void calculateDimension()
 {
     int maxWidth = 0;
     for (Box child : childs)
     {
         if (child.width > maxWidth)
         {
             maxWidth = child.width;
         }
         height += child.height;
     }
     width = maxWidth;
 }
      Specified by:
      calculateDimension in class Box