//
// ComboBox.cs: ComboBox control
//
// Authors:
// Ross Ferguson (ross.c.ferguson@btinternet.com)
//
using System;
using System.Collections;
using System.Collections.Generic;
using NStack;
namespace Terminal.Gui {
///
/// ComboBox control
///
public class ComboBox : View {
IListDataSource source;
///
/// Gets or sets the backing this , enabling custom rendering.
///
/// The source.
///
/// Use to set a new source.
///
public IListDataSource Source {
get => source;
set {
source = value;
// Only need to refresh list if its been added to a container view
if(SuperView != null && SuperView.Subviews.Contains(this)) {
Search_Changed ("");
SetNeedsDisplay ();
}
}
}
///
/// Sets the source of the to an .
///
/// An object implementing the IList interface.
///
/// Use the property to set a new source and use custome rendering.
///
public void SetSource (IList source)
{
if (source == null) {
Source = null;
} else {
listview.SetSource (source);
Source = listview.Source;
}
}
///
/// This event is raised when the selected item in the has changed.
///
public event Action SelectedItemChanged;
///
/// This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
///
public event Action OpenSelectedItem;
IList searchset;
ustring text = "";
readonly TextField search;
readonly ListView listview;
bool autoHide = true;
int minimumHeight = 2;
///
/// Public constructor
///
public ComboBox () : base ()
{
search = new TextField ("");
listview = new ListView () { LayoutStyle = LayoutStyle.Computed, CanFocus = true, TabStop = false };
Initialize ();
}
///
/// Public constructor
///
///
public ComboBox (ustring text) : base ()
{
search = new TextField ("");
listview = new ListView () { LayoutStyle = LayoutStyle.Computed, CanFocus = true, TabStop = false };
Initialize ();
Text = text;
}
///
/// Public constructor
///
///
///
public ComboBox (Rect rect, IList source) : base (rect)
{
search = new TextField ("") { Width = rect.Width };
listview = new ListView (rect, source) { LayoutStyle = LayoutStyle.Computed, ColorScheme = Colors.Base };
Initialize ();
SetSource (source);
}
private void Initialize ()
{
if (Bounds.Height < minimumHeight && Height is Dim.DimAbsolute) {
Height = minimumHeight;
}
search.TextChanged += Search_Changed;
listview.Y = Pos.Bottom (search);
listview.OpenSelectedItem += (ListViewItemEventArgs a) => Selected ();
this.Add (search, listview);
// On resize
LayoutComplete += (LayoutEventArgs a) => {
if (!autoHide && search.Frame.Width != Bounds.Width ||
autoHide && search.Frame.Width != Bounds.Width - 1) {
search.Width = listview.Width = autoHide ? Bounds.Width - 1 : Bounds.Width;
listview.Height = CalculatetHeight ();
search.SetRelativeLayout (Bounds);
listview.SetRelativeLayout (Bounds);
}
};
listview.SelectedItemChanged += (ListViewItemEventArgs e) => {
if (searchset.Count > 0) {
SetValue (searchset [listview.SelectedItem]);
}
};
Added += (View v) => {
// Determine if this view is hosted inside a dialog and is the only control
for (View view = this.SuperView; view != null; view = view.SuperView) {
if (view is Dialog && SuperView != null && SuperView.Subviews.Count == 1 && SuperView.Subviews[0] == this) {
autoHide = false;
break;
}
}
SetNeedsLayout ();
SetNeedsDisplay ();
Search_Changed (Text);
};
}
///
/// Gets the index of the currently selected item in the
///
/// The selected item or -1 none selected.
public int SelectedItem { private set; get; }
bool isShow = false;
///
public new ColorScheme ColorScheme {
get {
return base.ColorScheme;
}
set {
listview.ColorScheme = value;
base.ColorScheme = value;
SetNeedsDisplay ();
}
}
///
public override bool MouseEvent (MouseEvent me)
{
if (me.X == Bounds.Right - 1 && me.Y == Bounds.Top && me.Flags == MouseFlags.Button1Pressed
&& autoHide) {
if (isShow) {
isShow = false;
HideList ();
} else {
SetSearchSet ();
isShow = true;
ShowList ();
FocusSelectedItem ();
}
return true;
} else if (me.Flags == MouseFlags.Button1Pressed) {
if (!search.HasFocus) {
search.SetFocus ();
}
return true;
}
return false;
}
private void FocusSelectedItem ()
{
listview.SelectedItem = SelectedItem > -1 ? SelectedItem : 0;
if (SelectedItem > -1) {
listview.TabStop = true;
listview.SetFocus ();
}
}
///
public override bool OnEnter (View view)
{
if (!search.HasFocus && !listview.HasFocus) {
search.SetFocus ();
}
search.CursorPosition = search.Text.RuneCount;
return true;
}
///
public override bool OnLeave (View view)
{
if (autoHide && isShow && view != this && view != search && view != listview) {
isShow = false;
HideList ();
} else if (listview.TabStop) {
listview.TabStop = false;
}
return true;
}
///
/// Invokes the SelectedChanged event if it is defined.
///
///
public virtual bool OnSelectedChanged ()
{
// Note: Cannot rely on "listview.SelectedItem != lastSelectedItem" because the list is dynamic.
// So we cannot optimize. Ie: Don't call if not changed
SelectedItemChanged?.Invoke (new ListViewItemEventArgs(SelectedItem, search.Text));
return true;
}
///
/// Invokes the OnOpenSelectedItem event if it is defined.
///
///
public virtual bool OnOpenSelectedItem ()
{
var value = search.Text;
OpenSelectedItem?.Invoke (new ListViewItemEventArgs (SelectedItem, value));
return true;
}
///
public override void Redraw (Rect bounds)
{
base.Redraw (bounds);
if (!autoHide) {
return;
}
Move (Bounds.Right - 1, 0);
Driver.AddRune (Driver.DownArrow);
}
///
public override bool ProcessKey (KeyEvent e)
{
if (e.Key == Key.Enter && listview.SelectedItem > -1) {
Selected ();
return true;
}
if (e.Key == Key.F4 && (search.HasFocus || listview.HasFocus)) {
if (!isShow) {
SetSearchSet ();
isShow = true;
ShowList ();
FocusSelectedItem ();
} else {
isShow = false;
HideList ();
}
return true;
}
if (e.Key == Key.CursorDown && search.HasFocus) { // jump to list
if (searchset.Count > 0) {
listview.TabStop = true;
listview.SetFocus ();
SetValue (searchset [listview.SelectedItem]);
return true;
} else {
listview.TabStop = false;
SuperView.FocusNext ();
}
}
if (e.Key == Key.CursorUp && search.HasFocus) { // stop odd behavior on KeyUp when search has focus
return true;
}
if (e.Key == Key.CursorUp && listview.HasFocus && listview.SelectedItem == 0 && searchset.Count > 0) // jump back to search
{
search.CursorPosition = search.Text.RuneCount;
search.SetFocus ();
return true;
}
if(e.Key == Key.PageDown) {
if (listview.SelectedItem != -1) {
listview.MovePageDown ();
}
return true;
}
if (e.Key == Key.PageUp) {
if (listview.SelectedItem != -1) {
listview.MovePageUp ();
}
return true;
}
if (e.Key == Key.Home) {
if (listview.SelectedItem != -1) {
listview.MoveHome ();
}
return true;
}
if(e.Key == Key.End) {
if(listview.SelectedItem != -1) {
listview.MoveEnd ();
}
return true;
}
if (e.Key == Key.Esc) {
search.SetFocus ();
search.Text = text = "";
OnSelectedChanged ();
return true;
}
// Unix emulation
if (e.Key == (Key.U | Key.CtrlMask)) {
Reset ();
return true;
}
return base.ProcessKey (e);
}
///
/// The currently selected list item
///
public new ustring Text {
get {
return text;
}
set {
search.Text = text = value;
}
}
private void SetValue (object text)
{
search.TextChanged -= Search_Changed;
this.text = search.Text = text.ToString();
search.CursorPosition = 0;
search.TextChanged += Search_Changed;
SelectedItem = GetSelectedItemFromSource (this.text);
OnSelectedChanged ();
}
private void Selected ()
{
isShow = false;
listview.TabStop = false;
if (listview.Source.Count == 0 || searchset.Count == 0) {
text = "";
return;
}
SetValue (searchset [listview.SelectedItem]);
search.CursorPosition = search.Text.RuneCount;
Search_Changed (search.Text);
OnOpenSelectedItem ();
Reset (keepSearchText: true);
}
private int GetSelectedItemFromSource (ustring value)
{
if (source == null) {
return -1;
}
for (int i = 0; i < source.Count; i++) {
if (source.ToList () [i].ToString () == value) {
return i;
}
}
return -1;
}
///
/// Reset to full original list
///
private void Reset (bool keepSearchText = false)
{
if (!keepSearchText) {
search.Text = text = "";
}
ResetSearchSet ();
listview.SetSource (searchset);
listview.Height = CalculatetHeight ();
if (Subviews.Count > 0) {
search.SetFocus ();
}
}
private void ResetSearchSet (bool noCopy = false)
{
if (searchset == null) {
searchset = new List