using NStack;
using System;
using Terminal.Gui.Graphs;
namespace Terminal.Gui {
///
/// A consisting of a moveable bar that divides
/// the display area into 2 resizeable panels.
///
public class SplitContainer : View {
private SplitContainerLineView splitterLine;
SplitContainer parentSplitPanel;
///
/// The showing in the left hand pane of a
/// or top of an
/// pane. May be another
/// if further splitter subdivisions are
/// desired (e.g. to create a resizeable grid.
///
public View Panel1 { get; private set; }
public int Panel1MinSize { get; set; }
public ustring Panel1Title { get; set; }
///
/// The showing in the right hand pane of a
/// or bottom of an
/// pane. May be another
/// if further splitter subdivisions are
/// desired (e.g. to create a resizeable grid.
///
public View Panel2 { get; private set; }
public int Panel2MinSize { get; set; }
public ustring Panel2Title { get; set; }
private Pos splitterDistance = Pos.Percent (50);
private Orientation orientation = Orientation.Vertical;
///
/// Creates a new instance of the SplitContainer class.
///
public SplitContainer ()
{
splitterLine = new SplitContainerLineView (this);
Panel1 = new View () { Width = Dim.Fill (), Height = Dim.Fill() };
Panel2 = new View () { Width = Dim.Fill (), Height = Dim.Fill () };
this.Add (Panel1);
this.Add (splitterLine);
this.Add (Panel2);
CanFocus = true;
}
///
/// Invoked when the is changed
///
public event SplitterEventHandler SplitterMoved;
///
/// Raises the event
///
protected virtual void OnSplitterMoved ()
{
SplitterMoved?.Invoke (this, new SplitterEventArgs (this, splitterDistance));
}
///
/// Orientation of the dividing line (Horizontal or Vertical).
///
public Orientation Orientation {
get { return orientation; }
set {
orientation = value;
LayoutSubviews ();
}
}
public override void LayoutSubviews ()
{
if(this.IsRootSplitContainer()) {
Setup (this, Bounds);
}
base.LayoutSubviews ();
}
///
/// Distance Horizontally or Vertically to the splitter line when
/// neither panel is collapsed.
///
/// Only absolute values (e.g. 10) and percent values (i.e. )
/// are supported for this property.
///
public Pos SplitterDistance {
get { return splitterDistance; }
set {
if (!(value is Pos.PosAbsolute) && !(value is Pos.PosFactor)) {
throw new ArgumentException ($"Only Percent and Absolute values are supported for {nameof (SplitterDistance)} property. Passed value was {value.GetType ().Name}");
}
splitterDistance = value;
GetRootSplitContainer ().LayoutSubviews ();
OnSplitterMoved ();
}
}
///
public override bool OnEnter (View view)
{
Driver.SetCursorVisibility (CursorVisibility.Invisible);
return base.OnEnter (view);
}
///
public override void Redraw (Rect bounds)
{
Driver.SetAttribute (ColorScheme.Normal);
Clear ();
base.Redraw (bounds);
// Draw Splitter over Border (to get Ts)
if (splitterLine.Visible) {
splitterLine.Redraw (bounds);
}
// TODO:
// Draw Titles over Border
var screen = ViewToScreen (bounds);
if (Panel1.Visible && Panel1Title.Length > 0) {
Driver.SetAttribute (Panel1.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal);
Driver.DrawWindowTitle (new Rect (screen.X, screen.Y, Panel1.Frame.Width, 1), Panel1Title, 0, 0, 0, 0);
}
if (splitterLine.Visible) {
screen = ViewToScreen (splitterLine.Frame);
} else {
screen.X--;
screen.Y--;
}
if (Orientation == Orientation.Horizontal) {
if (Panel2.Visible && Panel2Title?.Length > 0) {
Driver.SetAttribute (Panel2.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal);
Driver.DrawWindowTitle (new Rect (screen.X + 1, screen.Y + 1, Panel2.Bounds.Width, 1), Panel2Title, 0, 0, 0, 0);
}
} else {
if (Panel2.Visible && Panel2Title?.Length > 0) {
Driver.SetAttribute (Panel2.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal);
Driver.DrawWindowTitle (new Rect (screen.X + 1, screen.Y + 1, Panel2.Bounds.Width, 1), Panel2Title, 0, 0, 0, 0);
}
}
}
private bool IsRootSplitContainer ()
{
// TODO: don't want to layout subviews since the parent recursively lays them all out
return parentSplitPanel == null;
}
private SplitContainer GetRootSplitContainer ()
{
SplitContainer root = this;
while (root.parentSplitPanel != null) {
root = root.parentSplitPanel;
}
return root;
}
private void Setup (SplitContainer splitContainer, Rect bounds)
{
splitterLine.Orientation = Orientation;
// splitterLine.Text = Panel2.Title;
// TODO: Recursion
if (!Panel1.Visible || !Panel2.Visible) {
View toFullSize = !Panel1.Visible ? Panel2 : Panel1;
splitterLine.Visible = false;
toFullSize.X = 0;
toFullSize.Y = 0;
toFullSize.Width = Dim.Fill ();
toFullSize.Height = Dim.Fill ();
} else {
splitterLine.Visible = true;
splitterDistance = BoundByMinimumSizes (splitterDistance);
Panel1.X = 0;
Panel1.Y = 0;
Panel2.Width = Dim.Fill ();
Panel2.Height = Dim.Fill ();
switch (Orientation) {
case Orientation.Horizontal:
splitterLine.X = 0;
splitterLine.Y = splitterDistance;
splitterLine.Width = Dim.Fill () + 1;
splitterLine.Height = 1;
splitterLine.LineRune = Driver.HLine;
Panel1.Width = Dim.Fill ();
Panel1.Height = new Dim.DimFunc (() =>
splitterDistance.Anchor (Bounds.Height));
Panel2.Y = Pos.Bottom (splitterLine);
Panel2.X = 0;
break;
case Orientation.Vertical:
splitterLine.X = splitterDistance;
splitterLine.Y = 0;
splitterLine.Width = 1;
splitterLine.Height = Dim.Fill () + 1;
splitterLine.LineRune = Driver.VLine;
Panel1.Height = Dim.Fill ();
Panel1.Width = new Dim.DimFunc (() =>
splitterDistance.Anchor (Bounds.Width));
Panel2.X = Pos.Right (splitterLine);
Panel2.Y = 0;
break;
default: throw new ArgumentOutOfRangeException (nameof (orientation));
};
}
}
///
/// Considers as a candidate for
/// then either returns (if valid) or returns adjusted if invalid with respect to the
/// of the panels.
///
///
///
private Pos BoundByMinimumSizes (Pos pos)
{
// if we are not yet initialized then we don't know
// how big we are and therefore cannot sensibly calculate
// how big the panels will be with a given SplitterDistance
if (!IsInitialized) {
return pos;
}
var availableSpace = Orientation == Orientation.Horizontal ? this.Bounds.Height : this.Bounds.Width;
var idealPosition = pos.Anchor (availableSpace);
// bad position because not enough space for Panel1
if (idealPosition < Panel1MinSize) {
// TODO: we should preserve Absolute/Percent status here not just force it to absolute
return (Pos)Math.Min (Panel1MinSize, availableSpace);
}
// if there is a border then 2 screen units are taken occupied
// by the border around the edge (one on left, one on right).
if (HasBorder ()) {
availableSpace -= 2;
}
// bad position because not enough space for Panel2
if (availableSpace - idealPosition <= Panel2MinSize) {
// TODO: we should preserve Absolute/Percent status here not just force it to absolute
// +1 is to allow space for the splitter
return (Pos)Math.Max (availableSpace - (Panel2MinSize + 1), 0);
}
// this splitter position is fine, there is enough space for everyone
return pos;
}
///
/// A panel within a .
///
public class SplitterPanel : View {
Pos minSize = 1;
///
/// Gets or sets the minimum size for the panel.
///
public Pos MinSize { get => minSize;
set {
minSize = value;
SuperView?.SetNeedsLayout ();
}
}
ustring title = ustring.Empty;
///
/// The title to be displayed for this . The title will be rendered
/// on the top border aligned to the left of the panel.
///
/// The title.
public ustring Title {
get => title;
set {
title = value;
SetNeedsDisplay ();
}
}
///
public override void Redraw (Rect bounds)
{
Driver.SetAttribute (ColorScheme.Normal);
base.Redraw (bounds);
}
///
public override void OnVisibleChanged ()
{
base.OnVisibleChanged ();
SuperView?.SetNeedsLayout ();
}
}
private class SplitContainerLineView : LineView {
private SplitContainer parent;
Point? dragPosition;
Pos dragOrignalPos;
Point? moveRuneRenderLocation;
public SplitContainerLineView (SplitContainer parent)
{
CanFocus = true;
TabStop = true;
this.parent = parent;
base.AddCommand (Command.Right, () => {
return MoveSplitter (1, 0);
});
base.AddCommand (Command.Left, () => {
return MoveSplitter (-1, 0);
});
base.AddCommand (Command.LineUp, () => {
return MoveSplitter (0, -1);
});
base.AddCommand (Command.LineDown, () => {
return MoveSplitter (0, 1);
});
AddKeyBinding (Key.CursorRight, Command.Right);
AddKeyBinding (Key.CursorLeft, Command.Left);
AddKeyBinding (Key.CursorUp, Command.LineUp);
AddKeyBinding (Key.CursorDown, Command.LineDown);
LayoutStarted += (e) => {
moveRuneRenderLocation = null;
if (Orientation == Orientation.Horizontal) {
StartingAnchor = parent.HasBorder () ? Driver.LeftTee : (Rune?)null;
EndingAnchor = parent.HasBorder () ? Driver.RightTee : (Rune?)null;
} else {
StartingAnchor = parent.HasBorder () ? Driver.TopTee : (Rune?)null;
EndingAnchor = parent.HasBorder () ? Driver.BottomTee : (Rune?)null;
}
};
}
public override bool ProcessKey (KeyEvent kb)
{
if (!CanFocus || !HasFocus) {
return base.ProcessKey (kb);
}
var result = InvokeKeybindings (kb);
if (result != null)
return (bool)result;
return base.ProcessKey (kb);
}
public override void PositionCursor ()
{
base.PositionCursor ();
var location = moveRuneRenderLocation ??
new Point (Bounds.Width / 2, Bounds.Height / 2);
Move (location.X, location.Y);
}
public override bool OnEnter (View view)
{
Driver.SetCursorVisibility (CursorVisibility.Default);
PositionCursor ();
return base.OnEnter (view);
}
public override void Redraw (Rect bounds)
{
base.Redraw (bounds);
if (CanFocus && HasFocus) {
var location = moveRuneRenderLocation ??
new Point (Bounds.Width / 2, Bounds.Height / 2);
AddRune (location.X, location.Y, Driver.Diamond);
}
}
public override bool MouseEvent (MouseEvent mouseEvent)
{
if (!CanFocus) {
return true;
}
if (!dragPosition.HasValue && (mouseEvent.Flags == MouseFlags.Button1Pressed)) {
// Start a Drag
SetFocus ();
Application.EnsuresTopOnFront ();
if (mouseEvent.Flags == MouseFlags.Button1Pressed) {
dragPosition = new Point (mouseEvent.X, mouseEvent.Y);
dragOrignalPos = Orientation == Orientation.Horizontal ? Y : X;
Application.GrabMouse (this);
if (Orientation == Orientation.Horizontal) {
} else {
moveRuneRenderLocation = new Point (0, Math.Max (1, Math.Min (Bounds.Height - 2, mouseEvent.Y)));
}
}
return true;
} else if (
dragPosition.HasValue &&
(mouseEvent.Flags == (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))) {
// Continue Drag
// how far has user dragged from original location?
if (Orientation == Orientation.Horizontal) {
int dy = mouseEvent.Y - dragPosition.Value.Y;
parent.SplitterDistance = Offset (Y, dy);
moveRuneRenderLocation = new Point (mouseEvent.X, 0);
} else {
int dx = mouseEvent.X - dragPosition.Value.X;
parent.SplitterDistance = Offset (X, dx);
moveRuneRenderLocation = new Point (0, Math.Max (1, Math.Min (Bounds.Height - 2, mouseEvent.Y)));
}
parent.SetNeedsDisplay ();
return true;
}
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Released) && dragPosition.HasValue) {
// End Drag
Application.UngrabMouse ();
Driver.UncookMouse ();
FinalisePosition (
dragOrignalPos,
Orientation == Orientation.Horizontal ? Y : X);
dragPosition = null;
//moveRuneRenderLocation = null;
}
return false;
}
private bool MoveSplitter (int distanceX, int distanceY)
{
if (Orientation == Orientation.Vertical) {
// Cannot move in this direction
if (distanceX == 0) {
return false;
}
var oldX = X;
FinalisePosition (oldX, (Pos)Offset (X, distanceX));
return true;
} else {
// Cannot move in this direction
if (distanceY == 0) {
return false;
}
var oldY = Y;
FinalisePosition (oldY, (Pos)Offset (Y, distanceY));
return true;
}
}
private Pos Offset (Pos pos, int delta)
{
var posAbsolute = pos.Anchor (Orientation == Orientation.Horizontal ?
parent.Bounds.Height : parent.Bounds.Width);
return posAbsolute + delta;
}
///
///
/// Moves to
/// preserving format
/// (absolute / relative) that had.
///
/// This ensures that if splitter location was e.g. 50% before and you move it
/// to absolute 5 then you end up with 10% (assuming a parent had 50 width).
///
///
///
private void FinalisePosition (Pos oldValue, Pos newValue)
{
if (oldValue is Pos.PosFactor) {
if (Orientation == Orientation.Horizontal) {
parent.SplitterDistance = ConvertToPosFactor (newValue, parent.Bounds.Height);
} else {
parent.SplitterDistance = ConvertToPosFactor (newValue, parent.Bounds.Width);
}
} else {
parent.SplitterDistance = newValue;
}
}
///
///
/// Determines the absolute position of and
/// returns a that describes the percentage of that.
///
/// Effectively turning any into a
/// (as if created with )
///
/// The to convert to
/// The Height/Width that lies within
///
private Pos ConvertToPosFactor (Pos p, int parentLength)
{
// calculate position in the 'middle' of the cell at p distance along parentLength
float position = p.Anchor (parentLength) + 0.5f;
return new Pos.PosFactor (position / parentLength);
}
}
private bool HasBorder ()
{
return Border != null && Border.BorderStyle != BorderStyle.None;
}
}
///
/// Provides data for events.
///
public class SplitterEventArgs : EventArgs {
///
/// Creates a new instance of the class.
///
///
///
public SplitterEventArgs (SplitContainer splitContainer, Pos splitterDistance)
{
SplitterDistance = splitterDistance;
SplitContainer = splitContainer;
}
///
/// New position of the
///
public Pos SplitterDistance { get; }
///
/// Container (sender) of the event.
///
public SplitContainer SplitContainer { get; }
}
///
/// Represents a method that will handle splitter events.
///
public delegate void SplitterEventHandler (object sender, SplitterEventArgs e);
}