Struct RenderTable 

pub struct RenderTable { /* private fields */ }

A table where the columns and rows are sized to fit the contents of the cells.

Implementations

impl RenderTable

pub fn new( app: &mut App, text_direction: TextDirection, ) -> RenderHandle<RenderTable>

Creates a table render object with no rows or columns.

Dart’s columns, rows and children arguments are set_columns, set_rows and set_children, and its other named arguments are the setters: set_column_widths (empty), set_default_column_width (FlexColumnWidth::default_width), set_border, set_row_decorations, set_configuration (ImageConfiguration::EMPTY), set_default_vertical_alignment (TableCellVerticalAlignment::Top) and set_text_baseline.

pub fn columns(self: RenderHandle<Self>, app: &App) -> usize

The number of vertical alignment lines in this table.

Changing the number of columns will remove any children that no longer fit in the table.

Changing the number of columns is an expensive operation because the table needs to rearrange its internal representation.

pub fn set_columns(self: RenderHandle<Self>, app: &mut App, value: usize)

Sets columns.

pub fn rows(self: RenderHandle<Self>, app: &App) -> usize

The number of horizontal alignment lines in this table.

Changing the number of rows will remove any children that no longer fit in the table.

pub fn set_rows(self: RenderHandle<Self>, app: &mut App, value: usize)

Sets rows.

pub fn column_widths( self: RenderHandle<Self>, app: &App, ) -> HashMap<usize, TableColumnWidthRef>

How the horizontal extents of the columns of this table should be determined.

If the map has no entry for a given column, the table uses the default_column_width instead.

The layout performance of the table depends critically on which column sizing algorithms are used here. In particular, IntrinsicColumnWidth is quite expensive because it needs to measure each cell in the column to determine the intrinsic size of the column.

This property can never return None. If it is set to None, and the existing map is not empty, then the value is replaced by an empty map. (If it is set to None while the current value is an empty map, the value is not changed.)

pub fn set_column_widths( self: RenderHandle<Self>, app: &mut App, value: Option<HashMap<usize, TableColumnWidthRef>>, )

Sets column_widths.

pub fn set_column_width( self: RenderHandle<Self>, app: &mut App, column: usize, value: TableColumnWidthRef, )

Determines how the width of column with the given index is determined.

pub fn default_column_width( self: RenderHandle<Self>, app: &App, ) -> TableColumnWidthRef

How to determine with widths of columns that don’t have an explicit sizing algorithm.

Specifically, the default_column_width is used for column i if column_widths[i] is absent.

pub fn set_default_column_width( self: RenderHandle<Self>, app: &mut App, value: TableColumnWidthRef, )

Sets default_column_width.

pub fn text_direction(self: RenderHandle<Self>, app: &App) -> TextDirection

The direction in which the columns are ordered.

pub fn set_text_direction( self: RenderHandle<Self>, app: &mut App, value: TextDirection, )

Sets text_direction.

pub fn border(self: RenderHandle<Self>, app: &App) -> Option<TableBorder>

The style to use when painting the boundary and interior divisions of the table.

pub fn set_border( self: RenderHandle<Self>, app: &mut App, value: Option<TableBorder>, )

Sets border.

pub fn row_decorations( self: RenderHandle<Self>, app: &App, ) -> &[Option<Box<dyn Decoration>>]

The decorations to use for each row of the table.

Row decorations fill the horizontal and vertical extent of each row in the table, unlike decorations for individual cells, which might not fill either.

pub fn set_row_decorations( self: RenderHandle<Self>, app: &mut App, value: Option<Vec<Option<Box<dyn Decoration>>>>, )

Sets row_decorations.

pub fn configuration(self: RenderHandle<Self>, app: &App) -> &ImageConfiguration

The settings to pass to the row_decorations when painting, so that they can resolve images appropriately. See ImageConfiguration.

pub fn set_configuration( self: RenderHandle<Self>, app: &mut App, value: ImageConfiguration, )

Sets configuration.

pub fn default_vertical_alignment( self: RenderHandle<Self>, app: &App, ) -> TableCellVerticalAlignment

How cells that do not explicitly specify a vertical alignment are aligned vertically.

pub fn set_default_vertical_alignment( self: RenderHandle<Self>, app: &mut App, value: TableCellVerticalAlignment, )

Sets default_vertical_alignment.

pub fn text_baseline( self: RenderHandle<Self>, app: &App, ) -> Option<TextBaseline>

The text baseline to use when aligning rows using TableCellVerticalAlignment::Baseline.

pub fn set_text_baseline( self: RenderHandle<Self>, app: &mut App, value: Option<TextBaseline>, )

Sets text_baseline.

pub fn set_flat_children( self: RenderHandle<Self>, app: &mut App, columns: usize, cells: Vec<Option<AnyRenderBox>>, )

Replaces the children of this table with the given cells.

The cells are divided into the specified number of columns before replacing the existing children.

If the new cells contain any existing children of the table, those children are moved to their new location in the table rather than removed from the table and re-added.

pub fn set_children( self: RenderHandle<Self>, app: &mut App, cells: Option<Vec<Vec<AnyRenderBox>>>, )

Replaces the children of this table with the given cells.

pub fn add_row( self: RenderHandle<Self>, app: &mut App, cells: Vec<Option<AnyRenderBox>>, )

Adds a row to the end of the table.

The newly added children must not already have parents.

pub fn set_child( self: RenderHandle<Self>, app: &mut App, x: usize, y: usize, value: Option<AnyRenderBox>, )

Replaces the child at the given position with the given child.

If the given child is already located at the given position, this function does not modify the table. Otherwise, the given child must not already have a parent.

pub fn column( self: RenderHandle<Self>, app: &App, x: usize, ) -> Vec<AnyRenderBox>

Returns the list of RenderBox objects that are in the given column, in row order, starting from the first row.

pub fn row(self: RenderHandle<Self>, app: &App, y: usize) -> Vec<AnyRenderBox>

Returns the list of RenderBox objects that are on the given row, in column order, starting with the first column.

pub fn get_row_box(self: RenderHandle<Self>, app: &App, row: usize) -> Rect

Returns the position and dimensions of the box that the given row covers, in this render object’s coordinate space (so the left coordinate is always 0.0).

The row being queried must exist.

This is only valid after layout.

Trait Implementations

impl RenderBox for RenderTable

fn compute_distance_to_actual_baseline( self: RenderHandle<Self>, app: &mut App, _baseline: TextBaseline, ) -> Option<f64>

Returns the baseline offset of the cell in the first row with the lowest baseline, and uses TableCellVerticalAlignment::Baseline.

fn render_box_data(self: RenderHandle<Self>, app: &App) -> &RenderBoxData

Mixin field access.

fn render_box_data_mut( self: RenderHandle<Self>, app: &mut App, ) -> &mut RenderBoxData

See render_box_data.

fn setup_parent_data( self: RenderHandle<Self>, app: &mut App, child: AnyRenderObject, )

Installs BoxParentData unless the child already has it.

fn compute_min_intrinsic_width( self: RenderHandle<Self>, app: &mut App, _height: f64, ) -> f64

Computes the value returned by get_min_intrinsic_width. Do not call this function directly, instead, call get_min_intrinsic_width.

fn compute_max_intrinsic_width( self: RenderHandle<Self>, app: &mut App, _height: f64, ) -> f64

Computes the value returned by get_max_intrinsic_width. Do not call this function directly, instead, call get_max_intrinsic_width.

fn compute_min_intrinsic_height( self: RenderHandle<Self>, app: &mut App, width: f64, ) -> f64

Computes the value returned by get_min_intrinsic_height. Do not call this function directly, instead, call get_min_intrinsic_height.

fn compute_max_intrinsic_height( self: RenderHandle<Self>, app: &mut App, width: f64, ) -> f64

Computes the value returned by get_max_intrinsic_height. Do not call this function directly, instead, call get_max_intrinsic_height.

fn compute_dry_baseline( self: RenderHandle<Self>, app: &mut App, constraints: BoxConstraints, baseline: TextBaseline, ) -> Option<f64>

Computes the value returned by get_dry_baseline.

fn compute_dry_layout( self: RenderHandle<Self>, app: &mut App, constraints: BoxConstraints, ) -> Size

Computes the value returned by get_dry_layout. Do not call this function directly, instead, call get_dry_layout.

fn hit_test_children( self: RenderHandle<Self>, app: &mut App, result: &mut BoxHitTestResult<'_>, position: Offset, ) -> bool

Override this method to check whether any children are located at the given position.

fn constraints(self: RenderHandle<Self>, app: &App) -> BoxConstraints

The box constraints most recently supplied by the parent.

fn get_min_intrinsic_width( self: RenderHandle<Self>, app: &mut App, height: f64, ) -> f64

See AnyRenderBox::get_min_intrinsic_width.

fn get_max_intrinsic_width( self: RenderHandle<Self>, app: &mut App, height: f64, ) -> f64

See AnyRenderBox::get_max_intrinsic_width.

fn get_min_intrinsic_height( self: RenderHandle<Self>, app: &mut App, width: f64, ) -> f64

See AnyRenderBox::get_min_intrinsic_height.

fn get_max_intrinsic_height( self: RenderHandle<Self>, app: &mut App, width: f64, ) -> f64

See AnyRenderBox::get_max_intrinsic_height.

fn get_dry_layout( self: RenderHandle<Self>, app: &mut App, constraints: BoxConstraints, ) -> Size

See AnyRenderBox::get_dry_layout.

fn get_dry_baseline( self: RenderHandle<Self>, app: &mut App, constraints: BoxConstraints, baseline: TextBaseline, ) -> Option<f64>

See AnyRenderBox::get_dry_baseline.

fn debug_cannot_compute_dry_layout( self: RenderHandle<Self>, failure: DryLayoutFailure<'_>, )

Called from compute_dry_layout or compute_dry_baseline if this box does not support calculating a dry layout.

fn get_distance_to_baseline( self: RenderHandle<Self>, app: &mut App, baseline: TextBaseline, only_real: bool, ) -> Option<f64>

See AnyRenderBox::get_distance_to_baseline.

fn get_distance_to_actual_baseline( self: RenderHandle<Self>, app: &mut App, baseline: TextBaseline, ) -> Option<f64>

See AnyRenderBox::get_distance_to_actual_baseline.

fn mark_needs_layout(self: RenderHandle<Self>, app: &mut App)

Mark this render object’s layout information as dirty.

fn perform_resize(self: RenderHandle<Self>, app: &mut App)

Updates the box’s size using only the constraints.

fn size(self: RenderHandle<Self>, app: &App) -> Size

The size of this box.

fn apply_paint_transform( self: RenderHandle<Self>, app: &App, child: AnyRenderObject, transform: &mut Matrix4, )

Multiply the transform from the parent’s coordinate system to this box’s coordinate system into the given transform.

fn paint_bounds(self: RenderHandle<Self>, app: &App) -> Rect

An estimate of the bounds within which this render object will paint: the box’s own size.

fn has_size(self: RenderHandle<Self>, app: &App) -> bool

Whether this render object has undergone layout and has a size.

fn handle_event( self: RenderHandle<Self>, app: &mut App, event: &PointerEvent, entry: &BoxHitTestEntry, )

Override this method to handle pointer events that hit this render object.

fn hit_test( self: RenderHandle<Self>, app: &mut App, result: &mut BoxHitTestResult<'_>, position: Offset, ) -> bool

Determines the set of render objects located at the given position.

fn hit_test_self( self: RenderHandle<Self>, _app: &App, _position: Offset, ) -> bool

Override this method if this render object can be hit even if its children were not hit.

fn set_size(self: RenderHandle<Self>, app: &mut App, size: Size)

Sets the size of this box. Call from RenderObject::perform_layout or RenderObject::perform_resize.

fn layout( self: RenderHandle<Self>, app: &mut App, constraints: BoxConstraints, parent_uses_size: bool, )

See AnyRenderBox::layout.

fn as_box(self: RenderHandle<Self>) -> AnyRenderBox

The type-erased RenderBox handle. Free: the vtable is a const, and the id is copied.

fn as_object(self: RenderHandle<Self>) -> AnyRenderObject

The type-erased RenderObject handle, through as_box.

fn adopt_child(self: RenderHandle<Self>, app: &mut App, child: AnyRenderObject)

See AnyRenderObject::adopt_child.

fn drop_child(self: RenderHandle<Self>, app: &mut App, child: AnyRenderObject)

See AnyRenderObject::drop_child.

fn mark_needs_paint(self: RenderHandle<Self>, app: &mut App)

See AnyRenderObject::mark_needs_paint.

fn mark_needs_composited_layer_update(self: RenderHandle<Self>, app: &mut App)

See AnyRenderObject::mark_needs_composited_layer_update.

fn mark_needs_compositing_bits_update(self: RenderHandle<Self>, app: &mut App)

See AnyRenderObject::mark_needs_compositing_bits_update.

fn schedule_initial_layout(self: RenderHandle<Self>, app: &mut App)

See AnyRenderObject::schedule_initial_layout.

fn parent(self: RenderHandle<Self>, app: &App) -> Option<AnyRenderObject>

See AnyRenderObject::parent.

fn owner(self: RenderHandle<Self>, app: &App) -> Option<Handle<PipelineOwner>>

See AnyRenderObject::owner.

fn attached(self: RenderHandle<Self>, app: &App) -> bool

See AnyRenderObject::attached.

fn debug_needs_layout(self: RenderHandle<Self>, app: &App) -> bool

See AnyRenderObject::debug_needs_layout.

impl RenderObject for RenderTable

fn render_object_data(self: RenderHandle<Self>, app: &App) -> &RenderObjectData

Mixin field access.

fn render_object_data_mut( self: RenderHandle<Self>, app: &mut App, ) -> &mut RenderObjectData

See render_object_data.

fn did_detach(self: RenderHandle<Self>, app: &mut App)

The body of Flutter’s detach override after super.detach(). The default detaches the children reported by visit_children.

fn visit_children( self: RenderHandle<Self>, app: &App, visitor: &mut dyn FnMut(AnyRenderObject), )

Calls visitor for each immediate child.

fn perform_layout(self: RenderHandle<Self>, app: &mut App)

Do the work of computing the layout for this render object.

fn paint( self: RenderHandle<Self>, app: &mut App, context: &mut PaintingContext, offset: Offset, )

Paint this render object into the given context at the given offset.

fn as_render_object(self: RenderHandle<Self>, app: &App) -> AnyRenderObject

Dart’s implicit upcast of a concrete render object to RenderObject: this object’s type-erased handle, through the vtable the protocol recorded when it created it.

fn perform_resize(self: RenderHandle<Self>, _app: &mut App)

Updates the render object’s size using only the constraints.

fn setup_parent_data( self: RenderHandle<Self>, app: &mut App, child: AnyRenderObject, )

Sets up parent data for child if it has none.

fn did_attach( self: RenderHandle<Self>, app: &mut App, owner: Handle<PipelineOwner>, )

The body of Flutter’s attach override after super.attach(owner); the base body has already run. The default attaches the children reported by visit_children.

fn redepth_children(self: RenderHandle<Self>, app: &mut App)

Adjusts the depth of each child reported by visit_children.

fn sized_by_parent(self: RenderHandle<Self>, _app: &App) -> bool

Whether the constraints are the only input to the sizing algorithm.

fn apply_paint_transform( self: RenderHandle<Self>, app: &App, child: AnyRenderObject, transform: &mut Matrix4, )

Applies the transform that would be applied when painting the given child to the given matrix.

fn is_repaint_boundary(self: RenderHandle<Self>, _app: &App) -> bool

Whether this render object repaints separately from its parent.

fn always_needs_compositing(self: RenderHandle<Self>, _app: &App) -> bool

Whether this render object always needs compositing.

fn mouse_tracker_annotation( self: RenderHandle<Self>, _app: &App, ) -> Option<MouseTrackerAnnotation>

Dart’s this is MouseTrackerAnnotation: the annotation this render object implements, read live each time the mouse tracker consults it. None for a render object that is not an annotation, which is the default.

fn update_composited_layer( self: RenderHandle<Self>, app: &mut App, old_layer: Option<AnyOffsetLayer>, ) -> AnyOffsetLayer

Update the composited layer owned by this render object.

fn show_on_screen( self: RenderHandle<Self>, app: &mut App, descendant: Option<AnyRenderObject>, rect: Option<Rect>, duration: Duration, curve: Rc<dyn Curve>, )

Attempt to make (a portion of) this or a descendant RenderObject visible on screen.

fn interface(self: RenderHandle<Self>, id: TypeId) -> Option<Box<dyn Any>>

Dart’s object is RenderAbstractViewport for any interface: the erased handle of the interface id names, if this type implements it.

fn dispose(self: RenderHandle<Self>, app: &mut App)

Release any resources held by this render object.