Struct genpdf::elements::TableLayout

pub struct TableLayout { /* fields omitted */ }

Arranges elements in columns and rows.

This struct can be used to layout arbitrary elements in columns in rows, or to draw typical tables. You can customize the cell style by providing a CellDecorator implementation. If you want to print a typical table with borders around the cells, use the FrameCellDecorator.

The column widths are determined by the weights that have been set in the constructor. The table always uses the full width of the provided area.

Examples

With setters:

use genpdf::elements;
let mut table = elements::TableLayout::new(vec![1, 1]);
table.set_cell_decorator(elements::FrameCellDecorator::new(true, true, false));
let mut row = table.row();
row.push_element(elements::Paragraph::new("Cell 1"));
row.push_element(elements::Paragraph::new("Cell 2"));
row.push().expect("Invalid table row");

Chained:

use genpdf::elements;
let table = elements::TableLayout::new(vec![1, 1])
    .row()
    .element(elements::Paragraph::new("Cell 1"))
    .element(elements::Paragraph::new("Cell 2"))
    .push()
    .expect("Invalid table row");

Implementations

impl TableLayout

pub fn new(column_weights: Vec<usize>) -> TableLayout

Creates a new table layout with the given column weights.

The column weights are used to determine the relative width of the columns. The number of column weights determines the number of columns in the table.

pub fn set_cell_decorator(&mut self, decorator: impl CellDecorator + 'static)

Sets the cell decorator for this table.

pub fn row(&mut self) -> TableLayoutRow<'_>

Adds a row to this table using the TableLayoutRow helper struct.

pub fn push_row(&mut self, row: Vec<Box<dyn Element>>) -> Result<(), Error>

Adds a row to this table.

The number of elements in the given vector must match the number of columns. Otherwise, an error is returned.

Trait Implementations

impl Element for TableLayout

fn render(
    &mut self,
    context: &Context,
    area: Area<'_>,
    style: Style
) -> Result<RenderResult, Error>

Renders this element to the given area using the given style and font cache.

fn framed(self) -> FramedElement<Self> where
    Self: Sized, 

Draws a frame around this element.

fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self> where
    Self: Sized, 

Adds a padding to this element.

fn styled(self, style: impl Into<Style>) -> StyledElement<Self> where
    Self: Sized, 

Sets the default style for this element and its children.