Merge pull request #1015 from tznind/table-view

New Control 'TableView' for viewing tabular data
This commit is contained in:
Charlie Kindel
2021-02-15 11:12:51 -07:00
committed by GitHub
5 changed files with 2764 additions and 0 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,526 @@
using System;
using System.Collections.Generic;
using System.Data;
using Terminal.Gui;
using System.Linq;
using System.Globalization;
using System.IO;
using System.Text;
using NStack;
namespace UICatalog.Scenarios {
[ScenarioMetadata (Name: "Csv Editor", Description: "Open and edit simple CSV files")]
[ScenarioCategory ("Controls")]
[ScenarioCategory ("Dialogs")]
[ScenarioCategory ("Text")]
[ScenarioCategory ("Dialogs")]
[ScenarioCategory ("TopLevel")]
public class CsvEditor : Scenario
{
TableView tableView;
private string currentFile;
private MenuItem miLeft;
private MenuItem miRight;
private MenuItem miCentered;
private Label selectedCellLabel;
public override void Setup ()
{
Win.Title = this.GetName();
Win.Y = 1; // menu
Win.Height = Dim.Fill (1); // status bar
Top.LayoutSubviews ();
this.tableView = new TableView () {
X = 0,
Y = 0,
Width = Dim.Fill (),
Height = Dim.Fill (1),
};
var menu = new MenuBar (new MenuBarItem [] {
new MenuBarItem ("_File", new MenuItem [] {
new MenuItem ("_Open CSV", "", () => Open()),
new MenuItem ("_Save", "", () => Save()),
new MenuItem ("_Quit", "", () => Quit()),
}),
new MenuBarItem ("_Edit", new MenuItem [] {
new MenuItem ("_New Column", "", () => AddColumn()),
new MenuItem ("_New Row", "", () => AddRow()),
new MenuItem ("_Rename Column", "", () => RenameColumn()),
new MenuItem ("_Delete Column", "", () => DeleteColum()),
new MenuItem ("_Move Column", "", () => MoveColumn()),
new MenuItem ("_Move Row", "", () => MoveRow()),
new MenuItem ("_Sort Asc", "", () => Sort(true)),
new MenuItem ("_Sort Desc", "", () => Sort(false)),
}),
new MenuBarItem ("_View", new MenuItem [] {
miLeft = new MenuItem ("_Align Left", "", () => Align(TextAlignment.Left)),
miRight = new MenuItem ("_Align Right", "", () => Align(TextAlignment.Right)),
miCentered = new MenuItem ("_Align Centered", "", () => Align(TextAlignment.Centered)),
// Format requires hard typed data table, when we read a CSV everything is untyped (string) so this only works for new columns in this demo
miCentered = new MenuItem ("_Set Format Pattern", "", () => SetFormat()),
})
});
Top.Add (menu);
var statusBar = new StatusBar (new StatusItem [] {
new StatusItem(Key.CtrlMask | Key.O, "~^O~ Open", () => Open()),
new StatusItem(Key.CtrlMask | Key.S, "~^S~ Save", () => Save()),
new StatusItem(Key.CtrlMask | Key.Q, "~^Q~ Quit", () => Quit()),
});
Top.Add (statusBar);
Win.Add (tableView);
selectedCellLabel = new Label(){
X = 0,
Y = Pos.Bottom(tableView),
Text = "0,0",
Width = Dim.Fill(),
TextAlignment = TextAlignment.Right
};
Win.Add(selectedCellLabel);
tableView.SelectedCellChanged += OnSelectedCellChanged;
tableView.CellActivated += EditCurrentCell;
tableView.KeyPress += TableViewKeyPress;
SetupScrollBar();
}
private void OnSelectedCellChanged (SelectedCellChangedEventArgs e)
{
selectedCellLabel.Text = $"{tableView.SelectedRow},{tableView.SelectedColumn}";
if(tableView.Table == null || tableView.SelectedColumn == -1)
return;
var col = tableView.Table.Columns[tableView.SelectedColumn];
var style = tableView.Style.GetColumnStyleIfAny(col);
miLeft.Checked = style?.Alignment == TextAlignment.Left;
miRight.Checked = style?.Alignment == TextAlignment.Right;
miCentered.Checked = style?.Alignment == TextAlignment.Centered;
}
private void RenameColumn ()
{
if(NoTableLoaded()) {
return;
}
var currentCol = tableView.Table.Columns[tableView.SelectedColumn];
if(GetText("Rename Column","Name:",currentCol.ColumnName,out string newName)) {
currentCol.ColumnName = newName;
tableView.Update();
}
}
private void DeleteColum()
{
if(NoTableLoaded()) {
return;
}
if(tableView.SelectedColumn == -1) {
MessageBox.ErrorQuery("No Column","No column selected", "Ok");
return;
}
try {
tableView.Table.Columns.RemoveAt(tableView.SelectedColumn);
tableView.Update();
} catch (Exception ex) {
MessageBox.ErrorQuery("Could not remove column",ex.Message, "Ok");
}
}
private void MoveColumn ()
{
if(NoTableLoaded()) {
return;
}
if(tableView.SelectedColumn == -1) {
MessageBox.ErrorQuery("No Column","No column selected", "Ok");
return;
}
try{
var currentCol = tableView.Table.Columns[tableView.SelectedColumn];
if(GetText("Move Column","New Index:",currentCol.Ordinal.ToString(),out string newOrdinal)) {
var newIdx = Math.Min(Math.Max(0,int.Parse(newOrdinal)),tableView.Table.Columns.Count-1);
currentCol.SetOrdinal(newIdx);
tableView.SetSelection(newIdx,tableView.SelectedRow,false);
tableView.EnsureSelectedCellIsVisible();
tableView.SetNeedsDisplay();
}
}catch(Exception ex)
{
MessageBox.ErrorQuery("Error moving column",ex.Message, "Ok");
}
}
private void Sort (bool asc)
{
if(NoTableLoaded()) {
return;
}
if(tableView.SelectedColumn == -1) {
MessageBox.ErrorQuery("No Column","No column selected", "Ok");
return;
}
var colName = tableView.Table.Columns[tableView.SelectedColumn].ColumnName;
tableView.Table.DefaultView.Sort = colName + (asc ? " asc" : " desc");
tableView.Table = tableView.Table.DefaultView.ToTable();
}
private void MoveRow ()
{
if(NoTableLoaded()) {
return;
}
if(tableView.SelectedRow == -1) {
MessageBox.ErrorQuery("No Rows","No row selected", "Ok");
return;
}
try{
int oldIdx = tableView.SelectedRow;
var currentRow = tableView.Table.Rows[oldIdx];
if(GetText("Move Row","New Row:",oldIdx.ToString(),out string newOrdinal)) {
var newIdx = Math.Min(Math.Max(0,int.Parse(newOrdinal)),tableView.Table.Rows.Count-1);
if(newIdx == oldIdx)
return;
var arrayItems = currentRow.ItemArray;
tableView.Table.Rows.Remove(currentRow);
// Removing and Inserting the same DataRow seems to result in it loosing its values so we have to create a new instance
var newRow = tableView.Table.NewRow();
newRow.ItemArray = arrayItems;
tableView.Table.Rows.InsertAt(newRow,newIdx);
tableView.SetSelection(tableView.SelectedColumn,newIdx,false);
tableView.EnsureSelectedCellIsVisible();
tableView.SetNeedsDisplay();
}
}catch(Exception ex)
{
MessageBox.ErrorQuery("Error moving column",ex.Message, "Ok");
}
}
private void Align (TextAlignment newAlignment)
{
if (NoTableLoaded ()) {
return;
}
var col = tableView.Table.Columns[tableView.SelectedColumn];
var style = tableView.Style.GetOrCreateColumnStyle(col);
style.Alignment = newAlignment;
miLeft.Checked = style.Alignment == TextAlignment.Left;
miRight.Checked = style.Alignment == TextAlignment.Right;
miCentered.Checked = style.Alignment == TextAlignment.Centered;
tableView.Update();
}
private void SetFormat()
{
if (NoTableLoaded ()) {
return;
}
var col = tableView.Table.Columns[tableView.SelectedColumn];
if(col.DataType == typeof(string)) {
MessageBox.ErrorQuery("Cannot Format Column","String columns cannot be Formatted, try adding a new column to the table with a date/numerical Type","Ok");
return;
}
var style = tableView.Style.GetOrCreateColumnStyle(col);
if(GetText("Format","Pattern:",style.Format ?? "",out string newPattern)) {
style.Format = newPattern;
tableView.Update();
}
}
private bool NoTableLoaded ()
{
if(tableView.Table == null) {
MessageBox.ErrorQuery("No Table Loaded","No table has currently be opened","Ok");
return true;
}
return false;
}
private void AddRow ()
{
if(NoTableLoaded()) {
return;
}
var newRow = tableView.Table.NewRow();
var newRowIdx = Math.Min(Math.Max(0,tableView.SelectedRow+1),tableView.Table.Rows.Count);
tableView.Table.Rows.InsertAt(newRow,newRowIdx);
tableView.Update();
}
private void AddColumn ()
{
if(NoTableLoaded()) {
return;
}
if(GetText("Enter column name","Name:","",out string colName)) {
var col = new DataColumn(colName);
var newColIdx = Math.Min(Math.Max(0,tableView.SelectedColumn + 1),tableView.Table.Columns.Count);
int result = MessageBox.Query(40,15,"Column Type","Pick a data type for the column",new ustring[]{"Date","Integer","Double","Text","Cancel"});
if(result <= -1 || result >= 4)
return;
switch(result) {
case 0: col.DataType = typeof(DateTime);
break;
case 1: col.DataType = typeof(int);
break;
case 2: col.DataType = typeof(double);
break;
case 3: col.DataType = typeof(string);
break;
}
tableView.Table.Columns.Add(col);
col.SetOrdinal(newColIdx);
tableView.Update();
}
}
private void Save()
{
if(tableView.Table == null || string.IsNullOrWhiteSpace(currentFile)) {
MessageBox.ErrorQuery("No file loaded","No file is currently loaded","Ok");
return;
}
var sb = new StringBuilder();
sb.AppendLine(string.Join(",",tableView.Table.Columns.Cast<DataColumn>().Select(c=>c.ColumnName)));
foreach(DataRow row in tableView.Table.Rows) {
sb.AppendLine(string.Join(",",row.ItemArray));
}
File.WriteAllText(currentFile,sb.ToString());
}
private void Open()
{
var ofd = new FileDialog("Select File","Open","File","Select a CSV file to open (does not support newlines, escaping etc)");
ofd.AllowedFileTypes = new string[]{".csv" };
Application.Run(ofd);
if(!string.IsNullOrWhiteSpace(ofd.FilePath?.ToString()))
{
Open(ofd.FilePath.ToString());
}
}
private void Open(string filename)
{
int lineNumber = 0;
currentFile = null;
try {
var dt = new DataTable();
var lines = File.ReadAllLines(filename);
foreach(var h in lines[0].Split(',')){
dt.Columns.Add(h);
}
foreach(var line in lines.Skip(1)) {
lineNumber++;
dt.Rows.Add(line.Split(','));
}
tableView.Table = dt;
// Only set the current filename if we succesfully loaded the entire file
currentFile = filename;
}
catch(Exception ex) {
MessageBox.ErrorQuery("Open Failed",$"Error on line {lineNumber}{Environment.NewLine}{ex.Message}","Ok");
}
}
private void SetupScrollBar ()
{
var _scrollBar = new ScrollBarView (tableView, true);
_scrollBar.ChangedPosition += () => {
tableView.RowOffset = _scrollBar.Position;
if (tableView.RowOffset != _scrollBar.Position) {
_scrollBar.Position = tableView.RowOffset;
}
tableView.SetNeedsDisplay ();
};
/*
_scrollBar.OtherScrollBarView.ChangedPosition += () => {
_listView.LeftItem = _scrollBar.OtherScrollBarView.Position;
if (_listView.LeftItem != _scrollBar.OtherScrollBarView.Position) {
_scrollBar.OtherScrollBarView.Position = _listView.LeftItem;
}
_listView.SetNeedsDisplay ();
};*/
tableView.DrawContent += (e) => {
_scrollBar.Size = tableView.Table?.Rows?.Count ??0;
_scrollBar.Position = tableView.RowOffset;
// _scrollBar.OtherScrollBarView.Size = _listView.Maxlength - 1;
// _scrollBar.OtherScrollBarView.Position = _listView.LeftItem;
_scrollBar.Refresh ();
};
}
private void TableViewKeyPress (View.KeyEventEventArgs e)
{
if(e.KeyEvent.Key == Key.DeleteChar){
if(tableView.FullRowSelect)
{
// Delete button deletes all rows when in full row mode
foreach(int toRemove in tableView.GetAllSelectedCells().Select(p=>p.Y).Distinct().OrderByDescending(i=>i))
tableView.Table.Rows.RemoveAt(toRemove);
}
else{
// otherwise set all selected cells to null
foreach(var pt in tableView.GetAllSelectedCells())
{
tableView.Table.Rows[pt.Y][pt.X] = DBNull.Value;
}
}
tableView.Update();
e.Handled = true;
}
}
private void ClearColumnStyles ()
{
tableView.Style.ColumnStyles.Clear();
tableView.Update();
}
private void CloseExample ()
{
tableView.Table = null;
}
private void Quit ()
{
Application.RequestStop ();
}
private bool GetText(string title, string label, string initialText, out string enteredText)
{
bool okPressed = false;
var ok = new Button ("Ok", is_default: true);
ok.Clicked += () => { okPressed = true; Application.RequestStop (); };
var cancel = new Button ("Cancel");
cancel.Clicked += () => { Application.RequestStop (); };
var d = new Dialog (title, 60, 20, ok, cancel);
var lbl = new Label() {
X = 0,
Y = 1,
Text = label
};
var tf = new TextField()
{
Text = initialText,
X = 0,
Y = 2,
Width = Dim.Fill()
};
d.Add (lbl,tf);
tf.SetFocus();
Application.Run (d);
enteredText = okPressed? tf.Text.ToString() : null;
return okPressed;
}
private void EditCurrentCell (CellActivatedEventArgs e)
{
if(e.Table == null)
return;
var oldValue = e.Table.Rows[e.Row][e.Col].ToString();
if(GetText("Enter new value",e.Table.Columns[e.Col].ColumnName,oldValue, out string newText)) {
try {
e.Table.Rows[e.Row][e.Col] = string.IsNullOrWhiteSpace(newText) ? DBNull.Value : (object)newText;
}
catch(Exception ex) {
MessageBox.ErrorQuery(60,20,"Failed to set text", ex.Message,"Ok");
}
tableView.Update();
}
}
}
}

View File

@@ -0,0 +1,394 @@
using System;
using System.Collections.Generic;
using System.Data;
using Terminal.Gui;
using System.Linq;
using System.Globalization;
namespace UICatalog.Scenarios {
[ScenarioMetadata (Name: "TableEditor", Description: "A Terminal.Gui DataTable editor via TableView")]
[ScenarioCategory ("Controls")]
[ScenarioCategory ("Dialogs")]
[ScenarioCategory ("Text")]
[ScenarioCategory ("Dialogs")]
[ScenarioCategory ("TopLevel")]
public class TableEditor : Scenario
{
TableView tableView;
private MenuItem miAlwaysShowHeaders;
private MenuItem miHeaderOverline;
private MenuItem miHeaderMidline;
private MenuItem miHeaderUnderline;
private MenuItem miCellLines;
private MenuItem miFullRowSelect;
public override void Setup ()
{
Win.Title = this.GetName();
Win.Y = 1; // menu
Win.Height = Dim.Fill (1); // status bar
Top.LayoutSubviews ();
this.tableView = new TableView () {
X = 0,
Y = 0,
Width = Dim.Fill (),
Height = Dim.Fill (1),
};
var menu = new MenuBar (new MenuBarItem [] {
new MenuBarItem ("_File", new MenuItem [] {
new MenuItem ("_OpenBigExample", "", () => OpenExample(true)),
new MenuItem ("_OpenSmallExample", "", () => OpenExample(false)),
new MenuItem ("_CloseExample", "", () => CloseExample()),
new MenuItem ("_Quit", "", () => Quit()),
}),
new MenuBarItem ("_View", new MenuItem [] {
miAlwaysShowHeaders = new MenuItem ("_AlwaysShowHeaders", "", () => ToggleAlwaysShowHeader()){Checked = tableView.Style.AlwaysShowHeaders, CheckType = MenuItemCheckStyle.Checked },
miHeaderOverline = new MenuItem ("_HeaderOverLine", "", () => ToggleOverline()){Checked = tableView.Style.ShowHorizontalHeaderOverline, CheckType = MenuItemCheckStyle.Checked },
miHeaderMidline = new MenuItem ("_HeaderMidLine", "", () => ToggleHeaderMidline()){Checked = tableView.Style.ShowVerticalHeaderLines, CheckType = MenuItemCheckStyle.Checked },
miHeaderUnderline =new MenuItem ("_HeaderUnderLine", "", () => ToggleUnderline()){Checked = tableView.Style.ShowHorizontalHeaderUnderline, CheckType = MenuItemCheckStyle.Checked },
miFullRowSelect =new MenuItem ("_FullRowSelect", "", () => ToggleFullRowSelect()){Checked = tableView.FullRowSelect, CheckType = MenuItemCheckStyle.Checked },
miCellLines =new MenuItem ("_CellLines", "", () => ToggleCellLines()){Checked = tableView.Style.ShowVerticalCellLines, CheckType = MenuItemCheckStyle.Checked },
new MenuItem ("_AllLines", "", () => ToggleAllCellLines()),
new MenuItem ("_NoLines", "", () => ToggleNoCellLines()),
new MenuItem ("_ClearColumnStyles", "", () => ClearColumnStyles()),
}),
});
Top.Add (menu);
var statusBar = new StatusBar (new StatusItem [] {
new StatusItem(Key.F2, "~F2~ OpenExample", () => OpenExample(true)),
new StatusItem(Key.F3, "~F3~ CloseExample", () => CloseExample()),
new StatusItem(Key.F4, "~F4~ OpenSimple", () => OpenSimple(true)),
new StatusItem(Key.CtrlMask | Key.Q, "~^Q~ Quit", () => Quit()),
});
Top.Add (statusBar);
Win.Add (tableView);
var selectedCellLabel = new Label(){
X = 0,
Y = Pos.Bottom(tableView),
Text = "0,0",
Width = Dim.Fill(),
TextAlignment = TextAlignment.Right
};
Win.Add(selectedCellLabel);
tableView.SelectedCellChanged += (e)=>{selectedCellLabel.Text = $"{tableView.SelectedRow},{tableView.SelectedColumn}";};
tableView.CellActivated += EditCurrentCell;
tableView.KeyPress += TableViewKeyPress;
SetupScrollBar();
}
private void SetupScrollBar ()
{
var _scrollBar = new ScrollBarView (tableView, true);
_scrollBar.ChangedPosition += () => {
tableView.RowOffset = _scrollBar.Position;
if (tableView.RowOffset != _scrollBar.Position) {
_scrollBar.Position = tableView.RowOffset;
}
tableView.SetNeedsDisplay ();
};
/*
_scrollBar.OtherScrollBarView.ChangedPosition += () => {
_listView.LeftItem = _scrollBar.OtherScrollBarView.Position;
if (_listView.LeftItem != _scrollBar.OtherScrollBarView.Position) {
_scrollBar.OtherScrollBarView.Position = _listView.LeftItem;
}
_listView.SetNeedsDisplay ();
};*/
tableView.DrawContent += (e) => {
_scrollBar.Size = tableView.Table?.Rows?.Count ??0;
_scrollBar.Position = tableView.RowOffset;
// _scrollBar.OtherScrollBarView.Size = _listView.Maxlength - 1;
// _scrollBar.OtherScrollBarView.Position = _listView.LeftItem;
_scrollBar.Refresh ();
};
}
private void TableViewKeyPress (View.KeyEventEventArgs e)
{
if(e.KeyEvent.Key == Key.DeleteChar){
if(tableView.FullRowSelect)
{
// Delete button deletes all rows when in full row mode
foreach(int toRemove in tableView.GetAllSelectedCells().Select(p=>p.Y).Distinct().OrderByDescending(i=>i))
tableView.Table.Rows.RemoveAt(toRemove);
}
else{
// otherwise set all selected cells to null
foreach(var pt in tableView.GetAllSelectedCells())
{
tableView.Table.Rows[pt.Y][pt.X] = DBNull.Value;
}
}
tableView.Update();
e.Handled = true;
}
}
private void ClearColumnStyles ()
{
tableView.Style.ColumnStyles.Clear();
tableView.Update();
}
private void ToggleAlwaysShowHeader ()
{
miAlwaysShowHeaders.Checked = !miAlwaysShowHeaders.Checked;
tableView.Style.AlwaysShowHeaders = miAlwaysShowHeaders.Checked;
tableView.Update();
}
private void ToggleOverline ()
{
miHeaderOverline.Checked = !miHeaderOverline.Checked;
tableView.Style.ShowHorizontalHeaderOverline = miHeaderOverline.Checked;
tableView.Update();
}
private void ToggleHeaderMidline ()
{
miHeaderMidline.Checked = !miHeaderMidline.Checked;
tableView.Style.ShowVerticalHeaderLines = miHeaderMidline.Checked;
tableView.Update();
}
private void ToggleUnderline ()
{
miHeaderUnderline.Checked = !miHeaderUnderline.Checked;
tableView.Style.ShowHorizontalHeaderUnderline = miHeaderUnderline.Checked;
tableView.Update();
}
private void ToggleFullRowSelect ()
{
miFullRowSelect.Checked = !miFullRowSelect.Checked;
tableView.FullRowSelect= miFullRowSelect.Checked;
tableView.Update();
}
private void ToggleCellLines()
{
miCellLines.Checked = !miCellLines.Checked;
tableView.Style.ShowVerticalCellLines = miCellLines.Checked;
tableView.Update();
}
private void ToggleAllCellLines()
{
tableView.Style.ShowHorizontalHeaderOverline = true;
tableView.Style.ShowVerticalHeaderLines = true;
tableView.Style.ShowHorizontalHeaderUnderline = true;
tableView.Style.ShowVerticalCellLines = true;
miHeaderOverline.Checked = true;
miHeaderMidline.Checked = true;
miHeaderUnderline.Checked = true;
miCellLines.Checked = true;
tableView.Update();
}
private void ToggleNoCellLines()
{
tableView.Style.ShowHorizontalHeaderOverline = false;
tableView.Style.ShowVerticalHeaderLines = false;
tableView.Style.ShowHorizontalHeaderUnderline = false;
tableView.Style.ShowVerticalCellLines = false;
miHeaderOverline.Checked = false;
miHeaderMidline.Checked = false;
miHeaderUnderline.Checked = false;
miCellLines.Checked = false;
tableView.Update();
}
private void CloseExample ()
{
tableView.Table = null;
}
private void Quit ()
{
Application.RequestStop ();
}
private void OpenExample (bool big)
{
tableView.Table = BuildDemoDataTable(big ? 30 : 5, big ? 1000 : 5);
SetDemoTableStyles();
}
private void SetDemoTableStyles ()
{
var alignMid = new ColumnStyle() {
Alignment = TextAlignment.Centered
};
var alignRight = new ColumnStyle() {
Alignment = TextAlignment.Right
};
var dateFormatStyle = new ColumnStyle() {
Alignment = TextAlignment.Right,
RepresentationGetter = (v)=> v is DateTime d ? d.ToString("yyyy-MM-dd"):v.ToString()
};
var negativeRight = new ColumnStyle() {
Format = "0.##",
MinWidth = 10,
AlignmentGetter = (v)=>v is double d ?
// align negative values right
d < 0 ? TextAlignment.Right :
// align positive values left
TextAlignment.Left:
// not a double
TextAlignment.Left
};
tableView.Style.ColumnStyles.Add(tableView.Table.Columns["DateCol"],dateFormatStyle);
tableView.Style.ColumnStyles.Add(tableView.Table.Columns["DoubleCol"],negativeRight);
tableView.Style.ColumnStyles.Add(tableView.Table.Columns["NullsCol"],alignMid);
tableView.Style.ColumnStyles.Add(tableView.Table.Columns["IntCol"],alignRight);
tableView.Update();
}
private void OpenSimple (bool big)
{
tableView.Table = BuildSimpleDataTable(big ? 30 : 5, big ? 1000 : 5);
}
private void EditCurrentCell (CellActivatedEventArgs e)
{
if(e.Table == null)
return;
var oldValue = e.Table.Rows[e.Row][e.Col].ToString();
bool okPressed = false;
var ok = new Button ("Ok", is_default: true);
ok.Clicked += () => { okPressed = true; Application.RequestStop (); };
var cancel = new Button ("Cancel");
cancel.Clicked += () => { Application.RequestStop (); };
var d = new Dialog ("Enter new value", 60, 20, ok, cancel);
var lbl = new Label() {
X = 0,
Y = 1,
Text = e.Table.Columns[e.Col].ColumnName
};
var tf = new TextField()
{
Text = oldValue,
X = 0,
Y = 2,
Width = Dim.Fill()
};
d.Add (lbl,tf);
tf.SetFocus();
Application.Run (d);
if(okPressed) {
try {
e.Table.Rows[e.Row][e.Col] = string.IsNullOrWhiteSpace(tf.Text.ToString()) ? DBNull.Value : (object)tf.Text;
}
catch(Exception ex) {
MessageBox.ErrorQuery(60,20,"Failed to set text", ex.Message,"Ok");
}
tableView.Update();
}
}
/// <summary>
/// Generates a new demo <see cref="DataTable"/> with the given number of <paramref name="cols"/> (min 5) and <paramref name="rows"/>
/// </summary>
/// <param name="cols"></param>
/// <param name="rows"></param>
/// <returns></returns>
public static DataTable BuildDemoDataTable(int cols, int rows)
{
var dt = new DataTable();
int explicitCols = 6;
dt.Columns.Add(new DataColumn("StrCol",typeof(string)));
dt.Columns.Add(new DataColumn("DateCol",typeof(DateTime)));
dt.Columns.Add(new DataColumn("IntCol",typeof(int)));
dt.Columns.Add(new DataColumn("DoubleCol",typeof(double)));
dt.Columns.Add(new DataColumn("NullsCol",typeof(string)));
dt.Columns.Add(new DataColumn("Unicode",typeof(string)));
for(int i=0;i< cols -explicitCols; i++) {
dt.Columns.Add("Column" + (i+explicitCols));
}
var r = new Random(100);
for(int i=0;i< rows;i++) {
List<object> row = new List<object>(){
"Some long text that is super cool",
new DateTime(2000+i,12,25),
r.Next(i),
(r.NextDouble()*i)-0.5 /*add some negatives to demo styles*/,
DBNull.Value,
"Les Mise" + Char.ConvertFromUtf32(Int32.Parse("0301", NumberStyles.HexNumber)) + "rables"
};
for(int j=0;j< cols -explicitCols; j++) {
row.Add("SomeValue" + r.Next(100));
}
dt.Rows.Add(row.ToArray());
}
return dt;
}
/// <summary>
/// Builds a simple table in which cell values contents are the index of the cell. This helps testing that scrolling etc is working correctly and not skipping out any rows/columns when paging
/// </summary>
/// <param name="cols"></param>
/// <param name="rows"></param>
/// <returns></returns>
public static DataTable BuildSimpleDataTable(int cols, int rows)
{
var dt = new DataTable();
for(int c = 0; c < cols; c++) {
dt.Columns.Add("Col"+c);
}
for(int r = 0; r < rows; r++) {
var newRow = dt.NewRow();
for(int c = 0; c < cols; c++) {
newRow[c] = $"R{r}C{c}";
}
dt.Rows.Add(newRow);
}
return dt;
}
}
}

447
UnitTests/TableViewTests.cs Normal file
View File

@@ -0,0 +1,447 @@
using System;
using System.Collections.Generic;
using System.Data;
using System.Linq;
using System.Threading.Tasks;
using Terminal.Gui;
using Xunit;
using System.Globalization;
namespace UnitTests {
public class TableViewTests
{
[Fact]
public void EnsureValidScrollOffsets_WithNoCells()
{
var tableView = new TableView();
Assert.Equal(0,tableView.RowOffset);
Assert.Equal(0,tableView.ColumnOffset);
// Set empty table
tableView.Table = new DataTable();
// Since table has no rows or columns scroll offset should default to 0
tableView.EnsureValidScrollOffsets();
Assert.Equal(0,tableView.RowOffset);
Assert.Equal(0,tableView.ColumnOffset);
}
[Fact]
public void EnsureValidScrollOffsets_LoadSmallerTable()
{
var tableView = new TableView();
tableView.Bounds = new Rect(0,0,25,10);
Assert.Equal(0,tableView.RowOffset);
Assert.Equal(0,tableView.ColumnOffset);
// Set big table
tableView.Table = BuildTable(25,50);
// Scroll down and along
tableView.RowOffset = 20;
tableView.ColumnOffset = 10;
tableView.EnsureValidScrollOffsets();
// The scroll should be valid at the moment
Assert.Equal(20,tableView.RowOffset);
Assert.Equal(10,tableView.ColumnOffset);
// Set small table
tableView.Table = BuildTable(2,2);
// Setting a small table should automatically trigger fixing the scroll offsets to ensure valid cells
Assert.Equal(0,tableView.RowOffset);
Assert.Equal(0,tableView.ColumnOffset);
// Trying to set invalid indexes should not be possible
tableView.RowOffset = 20;
tableView.ColumnOffset = 10;
Assert.Equal(1,tableView.RowOffset);
Assert.Equal(1,tableView.ColumnOffset);
}
[Fact]
public void SelectedCellChanged_NotFiredForSameValue()
{
var tableView = new TableView(){
Table = BuildTable(25,50)
};
bool called = false;
tableView.SelectedCellChanged += (e)=>{called=true;};
Assert.Equal(0,tableView.SelectedColumn);
Assert.False(called);
// Changing value to same as it already was should not raise an event
tableView.SelectedColumn = 0;
Assert.False(called);
tableView.SelectedColumn = 10;
Assert.True(called);
}
[Fact]
public void SelectedCellChanged_SelectedColumnIndexesCorrect()
{
var tableView = new TableView(){
Table = BuildTable(25,50)
};
bool called = false;
tableView.SelectedCellChanged += (e)=>{
called=true;
Assert.Equal(0,e.OldCol);
Assert.Equal(10,e.NewCol);
};
tableView.SelectedColumn = 10;
Assert.True(called);
}
[Fact]
public void SelectedCellChanged_SelectedRowIndexesCorrect()
{
var tableView = new TableView(){
Table = BuildTable(25,50)
};
bool called = false;
tableView.SelectedCellChanged += (e)=>{
called=true;
Assert.Equal(0,e.OldRow);
Assert.Equal(10,e.NewRow);
};
tableView.SelectedRow = 10;
Assert.True(called);
}
[Fact]
public void Test_SumColumnWidth_UnicodeLength()
{
Assert.Equal(11,"hello there".Sum(c=>Rune.ColumnWidth(c)));
// Creates a string with the peculiar (french?) r symbol
String surrogate = "Les Mise" + Char.ConvertFromUtf32(Int32.Parse("0301", NumberStyles.HexNumber)) + "rables";
// The unicode width of this string is shorter than the string length!
Assert.Equal(14,surrogate.Sum(c=>Rune.ColumnWidth(c)));
Assert.Equal(15,surrogate.Length);
}
[Fact]
public void IsSelected_MultiSelectionOn_Vertical()
{
var tableView = new TableView(){
Table = BuildTable(25,50),
MultiSelect = true
};
// 3 cell vertical selection
tableView.SetSelection(1,1,false);
tableView.SetSelection(1,3,true);
Assert.False(tableView.IsSelected(0,0));
Assert.False(tableView.IsSelected(1,0));
Assert.False(tableView.IsSelected(2,0));
Assert.False(tableView.IsSelected(0,1));
Assert.True(tableView.IsSelected(1,1));
Assert.False(tableView.IsSelected(2,1));
Assert.False(tableView.IsSelected(0,2));
Assert.True(tableView.IsSelected(1,2));
Assert.False(tableView.IsSelected(2,2));
Assert.False(tableView.IsSelected(0,3));
Assert.True(tableView.IsSelected(1,3));
Assert.False(tableView.IsSelected(2,3));
Assert.False(tableView.IsSelected(0,4));
Assert.False(tableView.IsSelected(1,4));
Assert.False(tableView.IsSelected(2,4));
}
[Fact]
public void IsSelected_MultiSelectionOn_Horizontal()
{
var tableView = new TableView(){
Table = BuildTable(25,50),
MultiSelect = true
};
// 2 cell horizontal selection
tableView.SetSelection(1,0,false);
tableView.SetSelection(2,0,true);
Assert.False(tableView.IsSelected(0,0));
Assert.True(tableView.IsSelected(1,0));
Assert.True(tableView.IsSelected(2,0));
Assert.False(tableView.IsSelected(3,0));
Assert.False(tableView.IsSelected(0,1));
Assert.False(tableView.IsSelected(1,1));
Assert.False(tableView.IsSelected(2,1));
Assert.False(tableView.IsSelected(3,1));
}
[Fact]
public void IsSelected_MultiSelectionOn_BoxSelection()
{
var tableView = new TableView(){
Table = BuildTable(25,50),
MultiSelect = true
};
// 4 cell horizontal in box 2x2
tableView.SetSelection(0,0,false);
tableView.SetSelection(1,1,true);
Assert.True(tableView.IsSelected(0,0));
Assert.True(tableView.IsSelected(1,0));
Assert.False(tableView.IsSelected(2,0));
Assert.True(tableView.IsSelected(0,1));
Assert.True(tableView.IsSelected(1,1));
Assert.False(tableView.IsSelected(2,1));
Assert.False(tableView.IsSelected(0,2));
Assert.False(tableView.IsSelected(1,2));
Assert.False(tableView.IsSelected(2,2));
}
[Fact]
public void PageDown_ExcludesHeaders()
{
var driver = new FakeDriver ();
Application.Init (driver, new FakeMainLoop (() => FakeConsole.ReadKey (true)));
driver.Init (() => { });
var tableView = new TableView(){
Table = BuildTable(25,50),
MultiSelect = true,
Bounds = new Rect(0,0,10,5)
};
// Header should take up 2 lines
tableView.Style.ShowHorizontalHeaderOverline = false;
tableView.Style.ShowHorizontalHeaderUnderline = true;
tableView.Style.AlwaysShowHeaders = false;
Assert.Equal(0,tableView.RowOffset);
tableView.ProcessKey(new KeyEvent(Key.PageDown,new KeyModifiers()));
// window height is 5 rows 2 are header so page down should give 3 new rows
Assert.Equal(3,tableView.RowOffset);
// header is no longer visible so page down should give 5 new rows
tableView.ProcessKey(new KeyEvent(Key.PageDown,new KeyModifiers()));
Assert.Equal(8,tableView.RowOffset);
}
[Fact]
public void DeleteRow_SelectAll_AdjustsSelectionToPreventOverrun()
{
// create a 4 by 4 table
var tableView = new TableView(){
Table = BuildTable(4,4),
MultiSelect = true,
Bounds = new Rect(0,0,10,5)
};
tableView.SelectAll();
Assert.Equal(16,tableView.GetAllSelectedCells().Count());
// delete one of the columns
tableView.Table.Columns.RemoveAt(2);
// table should now be 3x4
Assert.Equal(12,tableView.GetAllSelectedCells().Count());
// remove a row
tableView.Table.Rows.RemoveAt(1);
// table should now be 3x3
Assert.Equal(9,tableView.GetAllSelectedCells().Count());
}
[Fact]
public void DeleteRow_SelectLastRow_AdjustsSelectionToPreventOverrun()
{
// create a 4 by 4 table
var tableView = new TableView(){
Table = BuildTable(4,4),
MultiSelect = true,
Bounds = new Rect(0,0,10,5)
};
// select the last row
tableView.MultiSelectedRegions.Clear();
tableView.MultiSelectedRegions.Push(new TableSelection(new Point(0,3), new Rect(0,3,4,1)));
Assert.Equal(4,tableView.GetAllSelectedCells().Count());
// remove a row
tableView.Table.Rows.RemoveAt(0);
tableView.EnsureValidSelection();
// since the selection no longer exists it should be removed
Assert.Empty(tableView.MultiSelectedRegions);
}
[Theory]
[InlineData(true)]
[InlineData(false)]
public void GetAllSelectedCells_SingleCellSelected_ReturnsOne(bool multiSelect)
{
var tableView = new TableView(){
Table = BuildTable(3,3),
MultiSelect = multiSelect,
Bounds = new Rect(0,0,10,5)
};
tableView.SetSelection(1,1,false);
Assert.Single(tableView.GetAllSelectedCells());
Assert.Equal(new Point(1,1),tableView.GetAllSelectedCells().Single());
}
[Fact]
public void GetAllSelectedCells_SquareSelection_ReturnsFour()
{
var tableView = new TableView(){
Table = BuildTable(3,3),
MultiSelect = true,
Bounds = new Rect(0,0,10,5)
};
// move cursor to 1,1
tableView.SetSelection(1,1,false);
// spread selection across to 2,2 (e.g. shift+right then shift+down)
tableView.SetSelection(2,2,true);
var selected = tableView.GetAllSelectedCells().ToArray();
Assert.Equal(4,selected.Length);
Assert.Equal(new Point(1,1),selected[0]);
Assert.Equal(new Point(2,1),selected[1]);
Assert.Equal(new Point(1,2),selected[2]);
Assert.Equal(new Point(2,2),selected[3]);
}
[Fact]
public void GetAllSelectedCells_SquareSelection_FullRowSelect()
{
var tableView = new TableView(){
Table = BuildTable(3,3),
MultiSelect = true,
FullRowSelect = true,
Bounds = new Rect(0,0,10,5)
};
// move cursor to 1,1
tableView.SetSelection(1,1,false);
// spread selection across to 2,2 (e.g. shift+right then shift+down)
tableView.SetSelection(2,2,true);
var selected = tableView.GetAllSelectedCells().ToArray();
Assert.Equal(6,selected.Length);
Assert.Equal(new Point(0,1),selected[0]);
Assert.Equal(new Point(1,1),selected[1]);
Assert.Equal(new Point(2,1),selected[2]);
Assert.Equal(new Point(0,2),selected[3]);
Assert.Equal(new Point(1,2),selected[4]);
Assert.Equal(new Point(2,2),selected[5]);
}
[Fact]
public void GetAllSelectedCells_TwoIsolatedSelections_ReturnsSix()
{
var tableView = new TableView(){
Table = BuildTable(20,20),
MultiSelect = true,
Bounds = new Rect(0,0,10,5)
};
/*
Sets up disconnected selections like:
00000000000
01100000000
01100000000
00000001100
00000000000
*/
tableView.MultiSelectedRegions.Clear();
tableView.MultiSelectedRegions.Push(new TableSelection(new Point(1,1),new Rect(1,1,2,2)));
tableView.MultiSelectedRegions.Push(new TableSelection(new Point(7,3),new Rect(7,3,2,1)));
tableView.SelectedColumn = 8;
tableView.SelectedRow = 3;
var selected = tableView.GetAllSelectedCells().ToArray();
Assert.Equal(6,selected.Length);
Assert.Equal(new Point(1,1),selected[0]);
Assert.Equal(new Point(2,1),selected[1]);
Assert.Equal(new Point(1,2),selected[2]);
Assert.Equal(new Point(2,2),selected[3]);
Assert.Equal(new Point(7,3),selected[4]);
Assert.Equal(new Point(8,3),selected[5]);
}
/// <summary>
/// Builds a simple table of string columns with the requested number of columns and rows
/// </summary>
/// <param name="cols"></param>
/// <param name="rows"></param>
/// <returns></returns>
public static DataTable BuildTable(int cols, int rows)
{
var dt = new DataTable();
for(int c = 0; c < cols; c++) {
dt.Columns.Add("Col"+c);
}
for(int r = 0; r < rows; r++) {
var newRow = dt.NewRow();
for(int c = 0; c < cols; c++) {
newRow[c] = $"R{r}C{c}";
}
dt.Rows.Add(newRow);
}
return dt;
}
}
}

View File

@@ -0,0 +1,56 @@
# Table View
This control supports viewing and editing tabular data. It provides a view of a [System.DataTable](https://docs.microsoft.com/en-us/dotnet/api/system.data.datatable?view=net-5.0).
System.DataTable is a core class of .net standard and can be created very easily
## Csv Example
You can create a DataTable from a CSV file by creating a new instance and adding columns and rows as you read them. For a robust solution however you might want to look into a CSV parser library that deals with escaping, multi line rows etc.
```csharp
var dt = new DataTable();
var lines = File.ReadAllLines(filename);
foreach(var h in lines[0].Split(',')){
dt.Columns.Add(h);
}
foreach(var line in lines.Skip(1)) {
dt.Rows.Add(line.Split(','));
}
```
## Database Example
All Ado.net database providers (Oracle, MySql, SqlServer etc) support reading data as DataTables for example:
```csharp
var dt = new DataTable();
using(var con = new SqlConnection("Server=myServerAddress;Database=myDataBase;Trusted_Connection=True;"))
{
con.Open();
var cmd = new SqlCommand("select * from myTable;",con);
var adapter = new SqlDataAdapter(cmd);
adapter.Fill(dt);
}
```
## Displaying the table
Once you have set up your data table set it in the view:
```csharp
tableView = new TableView () {
X = 0,
Y = 0,
Width = 50,
Height = 10,
};
tableView.Table = yourDataTable;
```