class Opal::UI::Table

Overview

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

Defined in:

opal/ui/components/table.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor methods inherited from class Opal::UI::Control

new new

Instance methods inherited from module Opal::UI::InputHookable

custom_inputs=(custom_inputs : Bool) custom_inputs=, custom_inputs? : Bool custom_inputs?, default_input_proc : Proc(InputEvent, Bool) | Nil default_input_proc, default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil) default_input_proc=, fallback_to_defaults!(enabled : Bool = true) : self fallback_to_defaults!, fallback_to_defaults=(fallback_to_defaults : Bool) fallback_to_defaults=, fallback_to_defaults? : Bool fallback_to_defaults?, focus : self focus, focused=(focused : Bool) focused=, focused? : Bool focused?, handle_default_input(event : InputEvent) : Bool handle_default_input, handle_input(event : InputEvent) : Bool handle_input, handle_key(key : Terminal::KeyEvent) : Bool handle_key, handle_mouse(event : Terminal::MouseEvent) : Bool handle_mouse, input_hook : Proc(InputEvent, Bool) | Nil input_hook, input_hook=(input_hook : Proc(InputEvent, Bool) | Nil) input_hook=, on_input(&block : self, InputEvent -> Bool) : self on_input, puppet(&block : self, InputEvent -> Bool) : self puppet, reset_inputs : self reset_inputs, setup_default_inputs : Nil setup_default_inputs, unfocus : self unfocus, use_custom_inputs!(enabled : Bool = true) : self use_custom_inputs!

Instance methods inherited from class Opal::UI::Element

add_class(name : String) : self add_class, children : Array(Element) children, classes : Set(String) classes, classes=(classes : Set(String)) classes=, has_class?(name : String) : Bool has_class?, id : String | Nil id, id=(id : String | Nil) id=, preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) preferred_print_size, preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) preferred_size, print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil print, query(selector : String) : Array(Element)
query(klass : T.class) : Array(T) forall T query, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T query_one, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T query_one?, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string

Instance methods inherited from module Opal::UI::Themable

current_theme : Theme current_theme, style(&block : self -> Nil) : self style, theme : Theme | Nil theme, theme=(theme : Theme | Nil) theme=, with_theme(new_theme : Theme | Symbol | String) : self with_theme

Constructor Detail

def self.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) #

[View source]

Class Method Detail

def self.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


[View source]
def self.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


[View source]

Instance Method Detail

def add_row(cells : Array(String)) : self #

[View source]
def border_fg : Color | Nil #

[View source]
def border_fg=(border_fg : Color | Nil) #

[View source]
def border_style : Border | Nil #

[View source]
def border_style=(border_style : Border | Nil) #

[View source]
def cursor_char : String | Nil #

[View source]
def cursor_char=(cursor_char : String | Nil) #

[View source]
def divider_char : String | Nil #

[View source]
def divider_char=(divider_char : String | Nil) #

[View source]
def handle_key(key : Terminal::KeyEvent) : Bool #
Description copied from module Opal::UI::InputHookable

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


[View source]
def handle_mouse(event : Terminal::MouseEvent) : Bool #
Description copied from module Opal::UI::InputHookable

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


[View source]
def header_bg : Color | Nil #

[View source]
def header_bg=(header_bg : Color | Nil) #

[View source]
def header_fg : Color | Nil #

[View source]
def header_fg=(header_fg : Color | Nil) #

[View source]
def headers : Array(String) #

[View source]
def headers=(headers : Array(String)) #

[View source]
def horizontal_char : Char | Nil #

[View source]
def horizontal_char=(horizontal_char : Char | Nil) #

[View source]
def junction_char : Char | Nil #

[View source]
def junction_char=(junction_char : Char | Nil) #

[View source]
def markdown_mode=(markdown_mode : Bool) #

[View source]
def markdown_mode? : Bool #

[View source]
def move_down(count : Int32 = 1) : self #

[View source]
def move_up(count : Int32 = 1) : self #

[View source]
def page_down(count : Int32 = 10) : self #

[View source]
def page_up(count : Int32 = 10) : self #

[View source]
def preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) #

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


[View source]
def preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) #

[View source]
def print_mode=(print_mode : Bool) #

[View source]
def print_mode? : Bool #

[View source]
def render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil #

[View source]
def render_print(buffer : Buffer, width : Int32, height : Int32) : Nil #

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


[View source]
def row(cells : Array(String)) : self #

[View source]
def rows : Array(Array(String)) #

[View source]
def rows=(rows : Array(Array(String))) #

[View source]
def scroll_offset : Int32 #

[View source]
def scroll_offset=(scroll_offset : Int32) #

[View source]
def select(idx : Int32 | Nil) : self #

[View source]
def selected_bg : Color | Nil #

[View source]
def selected_bg=(selected_bg : Color | Nil) #

[View source]
def selected_fg : Color | Nil #

[View source]
def selected_fg=(selected_fg : Color | Nil) #

[View source]
def selected_index : Int32 | Nil #

[View source]
def selected_index=(selected_index : Int32 | Nil) #

[View source]
def truncate=(truncate : Bool) #

[View source]
def truncate? : Bool #

[View source]
def vertical_char : Char | Nil #

[View source]
def vertical_char=(vertical_char : Char | Nil) #

[View source]
def visible_rows : Int32 | Nil #

[View source]
def visible_rows=(visible_rows : Int32 | Nil) #

[View source]
def zebra=(zebra : Bool) #

[View source]
def zebra? : Bool #

[View source]
def zebra_bg : Color | Nil #

[View source]
def zebra_bg=(zebra_bg : Color | Nil) #

[View source]