class

Opal::UI::Table

Inherits Opal::UI::Control < Opal::UI::InputHookable < Opal::UI::Element < Opal::UI::Themable < Reference < Object

Formatted data table component with column alignment, headers, row selection cursor, windowed scrolling pagination, and cell truncation.

Constructors

new(headers : Array(String) = [] of String, rows : Array(Array(String)) = [] of Array(String), header_fg : Color | Symbol | String | Nil = nil, header_bg : Color | Symbol | String | Nil = nil, border_fg : Color | Symbol | String | Nil = nil, selected_index : Int32 | Nil = nil, visible_rows : Int32 | Nil = nil, scroll_offset : Int32 = 0, truncate : Bool = true, zebra : Bool = false, selected_fg : Color | Symbol | String | Nil = nil, selected_bg : Color | Symbol | String | Nil = nil, zebra_bg : Color | Symbol | String | Nil = nil, cursor_char : String | Nil = nil, divider_char : String | Nil = nil, border_style : Border | Symbol | String | Nil = nil, print_mode : Bool = false)

Class methods

print(headers : Array(String), rows : Array(Array(String)), io : IO = STDOUT, width : Int32 | Nil = nil, zebra : Bool = false, border_style : Border | Symbol | String | Nil = nil, theme : Theme | Nil = nil, color : Bool | Nil = nil) : Nil

Class convenience method printing styled table directly to IO

to_string(headers : Array(String), rows : Array(Array(String)), width : Int32 | Nil = nil, zebra : Bool = false, border_style : Border | Symbol | String | Nil = nil, theme : Theme | Nil = nil, color : Bool | Nil = nil) : String

Class convenience method returning styled table string

Instance methods

add_row(cells : Array(String)) : self

border_fg

border_fg=(border_fg : Color | Nil)

border_style

border_style=(border_style : Border | Nil)

cursor_char

cursor_char=(cursor_char : String | Nil)

divider_char

divider_char=(divider_char : String | Nil)

handle_key(key : Terminal::KeyEvent) : Bool

Default key event handler. Override in subclasses if not using @default_input_proc.

handle_mouse(event : Terminal::MouseEvent) : Bool

Default mouse event handler. Override in subclasses if not using @default_input_proc.

header_bg

header_bg=(header_bg : Color | Nil)

header_fg

header_fg=(header_fg : Color | Nil)

headers

headers=(headers : Array(String))

horizontal_char

horizontal_char=(horizontal_char : Char | Nil)

junction_char

junction_char=(junction_char : Char | Nil)

markdown_mode=(markdown_mode : Bool)

markdown_mode?

move_down(count : Int32 = 1) : self

move_up(count : Int32 = 1) : self

page_down(count : Int32 = 10) : self

page_up(count : Int32 = 10) : self

preferred_print_size(available_w : Int32) : Tuple(Int32, Int32)

Preferred size in print mode: full row height and natural column width

preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)

print_mode=(print_mode : Bool)

print_mode?

render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil

render_print(buffer : Buffer, width : Int32, height : Int32) : Nil

Render hook for one-shot print mode: renders all rows without cursor or scroll clipping

row(cells : Array(String)) : self

rows

rows=(rows : Array(Array(String)))

scroll_offset

scroll_offset=(scroll_offset : Int32)

select(idx : Int32 | Nil) : self

selected_bg

selected_bg=(selected_bg : Color | Nil)

selected_fg

selected_fg=(selected_fg : Color | Nil)

selected_index

selected_index=(selected_index : Int32 | Nil)

truncate=(truncate : Bool)

truncate?

vertical_char

vertical_char=(vertical_char : Char | Nil)

visible_rows

visible_rows=(visible_rows : Int32 | Nil)

zebra=(zebra : Bool)

zebra?

zebra_bg

zebra_bg=(zebra_bg : Color | Nil)