Skip to content

Latest commit

 

History

History
207 lines (145 loc) · 10.4 KB

TextTable.md

File metadata and controls

207 lines (145 loc) · 10.4 KB
Raw

TextTable

A textTable is a table of text with automatic column computing, cell fitting and word-wrapping.

Each cell is a TextBox instance.

TextTable features:

  • Various table border support see borders/frames
  • Distinct attributes/styles/colors for:
    • frame/border
    • regular cells
    • first row
    • first column
    • first cell
    • even rows
    • even columns
    • even cells (cells in both even row and even column)
    • checkered cells
  • Fitting the table columns and rows to widget size: expand/shrink to width/height
  • Line or word wrapping inside of cells

Table of Contents

new TextTable( options )

  • options Object, where:
    • all of the base class Element constructor's options
    • cellContents array of array of string the text for each cell, the top-level array contains rows, the nested arrays contain cell of text
    • contentHasMarkup boolean or string as usual it indicates if the content has markup or ANSI code, see Element's documentation, except that here it applies to the cellContents options instead of content
    • textAttr object generic/default attributes for the cell's content (textBox), default to { bgColor: 'default' }
    • voidAttr object attributes for the area of the cell (textBox) without any text content, default to null
    • firstRowTextAttr object attributes for the cell's content of the first row, default to null (= no special attributes, fallback to another suitable attribute definition)
    • firstRowVoidAttr object attributes for the cell's void area, it is to firstRowTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenRowTextAttr object attributes for the cell's content of all even rows, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenRowVoidAttr object attributes for the cell's void area, it is to evenRowTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • firstColumnTextAttr object attributes for the cell's content of the first column, default to null (= no special attributes, fallback to another suitable attribute definition)
    • firstColumnVoidAttr object attributes for the cell's void area, it is to firstColumnTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenColumnTextAttr object attributes for the cell's content of all even columns, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenColumnVoidAttr object attributes for the cell's void area, it is to evenColumnTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • firstCellTextAttr object attributes for the cell's content of the first cell (i.e. the top-left cell), default to null (= no special attributes, fallback to another suitable attribute definition)
    • firstCellVoidAttr object attributes for the cell's void area, it is to firstCellTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenCellTextAttr object attributes for the cell's content of all cells that are both on an even row and on an even column, default to null (= no special attributes, fallback to another suitable attribute definition)
    • evenCellVoidAttr object attributes for the cell's void area, it is to evenCellTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • checkerEvenCellTextAttr object attributes for the cell's content of all checker-style-even cells, i.e.: when rowNumber + columnNumber is even, default to null (= no special attributes, fallback to another suitable attribute definition)
    • checkerEvenCellVoidAttr object attributes for the cell's void area, it is to checkerEvenCellTextAttr what voidAttr is to textAttr, default to null (= no special attributes, fallback to another suitable attribute definition)
    • expandToWidth boolean when set, expand columns' width to fill all the widget's width (default: false)
    • shrinkToWidth boolean when set, shrink the columns' width so it does not overflow the widget width (default: false)
    • expandToHeight boolean when set, expand rows' height to fill all the widget's height (default: false)
    • shrinkToHeight boolean when set, shrink the rows' height so it does not overflow the widget's height (default: false)
    • lineWrap boolean when set, the text content is wrapped to the next line instead of being clipped by the textBox border (default: false)
    • wordWrap boolean like lineWrap but is word-aware, i.e. it doesn't split words (default: false)
    • fit boolean shorthand, when set (default: false) it activates options: expandToWidth, shrinkToWidth, expandToHeight, shrinkToHeight and wordWrap
    • hasBorder boolean when set, draw frames/borders around cells, default to true
    • borderAttr object attributes for the borders chars, default to the textAttr option
    • borderChars object or string the chars used for the border, if it is a string, it is one of the built-in borders/frames, if it is an object, it should be in the border format, default to 'light'
    • textBoxKeyBindings object if set, it replaces default key-bindings for all the TextBox instances

This creates a TextTable element.

.setCellContent( x , y , content , [dontDraw] , [dontUpdateLayout] )

  • x,y number the cell coordinate to modify
  • content string the new content for this table cell
  • dontDraw boolean when set, the cell content's update does not trigger the redraw of the textTable (or of the cell's textBox if dontUpdateLayout is set)
  • dontUpdateLayout boolean when set, the table layout is not updated

This update an existing cell content. The table layout will be updated if needed, except if dontUpdateLayout is set. The content may contain markup, but it should have been enabled on the textTable creation for this to work.

.setCellAttr( x , y , textAttr , [voidAttr] , [dontDraw] )

  • x,y number the cell coordinate to modify
  • textAttr object generic/default attributes for the cell's content (textBox)
  • voidAttr object attributes for the area of the cell (textBox) without any text content, default to the textAttr argument
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the cell's textBox

This update an existing cell text attribute.

.resetCellAttr( x , y , [dontDraw] )

  • x,y number the cell coordinate to reset
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the cell's textBox

This reset an existing cell text attribute to what it should be, based upon the constructor's parameters.

.setRowAttr( y , textAttr , [voidAttr] , [dontDraw] )

  • y number the row's index to modify
  • textAttr object generic/default attributes for the row's cell's content (textBox)
  • voidAttr object attributes for the area of the cell (textBox) without any text content, default to the textAttr argument
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This update all cells' text attribute of a row.

.resetRowAttr( y , [dontDraw] )

  • y number the row's index to reset
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This reset all cells' text attribute of a row to what it should be, based upon the constructor's parameters.

.setColumnAttr( x , textAttr , voidAttr , [dontDraw] )

  • x number the column's index to modify
  • textAttr object generic/default attributes for the column's cell's content (textBox)
  • voidAttr object attributes for the area of the cell (textBox) without any text content, default to the textAttr argument
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This update all cells's text attribute of a column.

.resetColumnAttr( x , [dontDraw] )

  • x number the column's index to reset
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This reset all cells' text attribute of a column to what it should be, based upon the constructor's parameters.

.setTableAttr( textAttr , voidAttr , [dontDraw] )

  • textAttr object generic/default attributes for the table's cell's content (textBox)
  • voidAttr object attributes for the area of the cell (textBox) without any text content, default to the textAttr argument
  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This update all cells's text attribute.

.resetTableAttr( [dontDraw] )

  • dontDraw boolean when set, the cell attr's update does not trigger the redraw of the textTable

This reset all cells's text attribute to what it should be, based upon the constructor's parameters.