Struct rat_widget::table::RTable

pub struct RTable<'a, Selection> { /* private fields */ }

Implementations

impl<'a, Selection> RTable<'a, Selection>

pub fn new() -> Self

where Selection: Default,

New, empty Table.

pub fn new_ratatui<R, C>(rows: R, widths: C) -> Self

where R: IntoIterator, R::Item: Into<Row<'a>>, C: IntoIterator, C::Item: Into<Constraint>, Selection: Default,

Create a new FTable with preformatted data. For compatibility with ratatui.

Use of RTable::data is preferred.

pub fn rows<T>(self, rows: T) -> Self

where T: IntoIterator<Item = Row<'a>>,

Set preformatted row-data. For compatibility with ratatui.

Use of RTable::data is preferred.

pub fn data(self, data: impl TableData<'a> + 'a) -> Self

Set a reference to the TableData facade to your data.

The way to go is to define a small struct that contains just a reference to your data. Then implement TableData for this struct.

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::prelude::Style;
use ratatui::text::Span;
use ratatui::widgets::Widget;
use rat_ftable::{FTable, FTableState, TableData};


struct Data1<'a>(&'a [SampleRow]);

impl<'a> TableData<'a> for Data1<'a> {
    // returns (cols, rows)
    fn size(&self) -> (usize, usize) {
        (5, self.0.len())
    }

    fn row_height(&self, row: usize) -> u16 {
        // to some calculations ...
        1
    }

    fn row_style(&self, row: usize) -> Style {
        // to some calculations ...
        Style::default()
    }

    fn render_cell(&self, column: usize, row: usize, area: Rect, buf: &mut Buffer) {
        if let Some(data) = self.0.get(row) {
            let rend = match column {
                0 => Span::from("column1"),
                1 => Span::from("column2"),
                2 => Span::from("column3"),
                _ => return
            };
            rend.render(area, buf);
        }
    }
}

// When you are creating the table widget you hand over a reference
// to the facade struct.

let my_data_somewhere_else = vec![SampleRow;999999];
let mut table_state_somewhere_else = FTableState::default();

let tabledata1 = Data1(&my_data_somewhere_else);
let table1 = FTable::default().data(&tabledata1);
table1.render(area, buf, &mut table_state_somewhere_else);

pub fn iter(self, data: impl TableDataIter<'a> + 'a) -> Self

Alternative representation for the data is as an Iterator that yields a TableRowData.

Caution: If you can’t give the number of rows, the table will iterate over all the data.

pub fn header(self, header: Row<'a>) -> Self

Set the table-header.

pub fn footer(self, footer: Row<'a>) -> Self

Set the table-footer.

pub fn widths<I>(self, widths: I) -> Self

where I: IntoIterator, I::Item: Into<Constraint>,

Column widths as Constraints.

pub fn flex(self, flex: Flex) -> Self

Flex for layout.

pub fn column_spacing(self, spacing: u16) -> Self

Spacing between columns.

pub fn layout_width(self, width: u16) -> Self

Overrides the width of the rendering area for layout purposes. Layout uses this width, even if it means that some columns are not visible.

pub fn block(self, block: Block<'a>) -> Self

Draws a block around the table widget.

pub fn styles(self, styles: FTableStyle) -> Self

Set all styles as a bundle.

pub fn style(self, style: Style) -> Self

Base style for the table.

pub fn header_style(self, style: Option<Style>) -> Self

Base style for the table.

pub fn footer_style(self, style: Option<Style>) -> Self

Base style for the table.

pub fn select_row_style(self, select_style: Option<Style>) -> Self

Style for a selected row. The chosen selection must support row-selection for this to take effect.

pub fn show_row_focus(self, show: bool) -> Self

pub fn select_column_style(self, select_style: Option<Style>) -> Self

Style for a selected column. The chosen selection must support column-selection for this to take effect.

pub fn show_column_focus(self, show: bool) -> Self

pub fn select_cell_style(self, select_style: Option<Style>) -> Self

Style for a selected cell. The chosen selection must support cell-selection for this to take effect.

pub fn show_cell_focus(self, show: bool) -> Self

pub fn select_header_style(self, select_style: Option<Style>) -> Self

Style for a selected header cell. The chosen selection must support column-selection for this to take effect.

pub fn show_header_focus(self, show: bool) -> Self

pub fn select_footer_style(self, select_style: Option<Style>) -> Self

Style for a selected footer cell. The chosen selection must support column-selection for this to take effect.

pub fn show_footer_focus(self, show: bool) -> Self

pub fn focus_style(self, focus_style: Option<Style>) -> Self

This style will be patched onto the selection to indicate that the widget has the input focus.

The selection must support some kind of selection for this to be effective.

pub fn debug(self, debug: bool) -> Self

Trait Implementations

impl<'a, Selection: Debug> Debug for RTable<'a, Selection>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Selection: Default> Default for RTable<'a, Selection>

fn default() -> RTable<'a, Selection>

Returns the “default value” for a type.

impl<'a, Selection> ScrollingWidget<RTableState<Selection>> for RTable<'a, Selection>

fn need_scroll( &self, area: Rect, _state: &mut RTableState<Selection>, ) -> (bool, bool)

Widget wants a (horizontal, vertical) scrollbar. This gets combined with the ScrollbarPolicy.

impl<'a, Selection> StatefulWidget for RTable<'a, Selection>

where Selection: TableSelection,

type State = RTableState<Selection>

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl<'a, Selection> StatefulWidgetRef for RTable<'a, Selection>

where Selection: TableSelection,

type State = RTableState<Selection>

State associated with the stateful widget.

fn render_ref(&self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.