2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import jexer
.bits
.CellAttributes
;
32 import jexer
.bits
.GraphicsChars
;
33 import jexer
.event
.TMenuEvent
;
34 import jexer
.event
.TMouseEvent
;
35 import jexer
.event
.TResizeEvent
;
36 import jexer
.menu
.TMenu
;
39 * TSplitPane contains two widgets with a draggable horizontal or vertical
42 public class TSplitPane
extends TWidget
{
44 // ------------------------------------------------------------------------
45 // Variables --------------------------------------------------------------
46 // ------------------------------------------------------------------------
49 * If true, split vertically. If false, split horizontally.
51 private boolean vertical
= true;
54 * The location of the split bar, either as a column number for vertical
55 * split or a row number for horizontal split.
57 private int split
= 0;
60 * The widget on the left side.
65 * The widget on the right side.
67 private TWidget right
;
70 * The widget on the top side.
75 * The widget on the bottom side.
77 private TWidget bottom
;
80 * If true, we are in the middle of a split move.
82 private boolean inSplitMove
= false;
85 * The last seen mouse position.
87 private TMouseEvent mouse
;
89 // ------------------------------------------------------------------------
90 // Constructors -----------------------------------------------------------
91 // ------------------------------------------------------------------------
96 * @param parent parent widget
97 * @param x column relative to parent
98 * @param y row relative to parent
99 * @param width width of widget
100 * @param height height of widget
101 * @param vertical if true, split vertically
103 public TSplitPane(final TWidget parent
, final int x
, final int y
,
104 final int width
, final int height
, final boolean vertical
) {
106 super(parent
, x
, y
, width
, height
);
108 this.vertical
= vertical
;
112 // ------------------------------------------------------------------------
113 // Event handlers ---------------------------------------------------------
114 // ------------------------------------------------------------------------
117 * Handle window/screen resize events.
119 * @param event resize event
122 public void onResize(final TResizeEvent event
) {
123 if (event
.getType() == TResizeEvent
.Type
.WIDGET
) {
125 super.onResize(event
);
127 if (vertical
&& (split
>= getWidth() - 2)) {
129 } else if (!vertical
&& (split
>= getHeight() - 2)) {
138 * Handle mouse button presses.
140 * @param mouse mouse button event
143 public void onMouseDown(final TMouseEvent mouse
) {
148 if (mouse
.isMouse1()) {
150 inSplitMove
= (mouse
.getAbsoluteX() - getAbsoluteX() == split
);
152 inSplitMove
= (mouse
.getAbsoluteY() - getAbsoluteY() == split
);
159 // I didn't take it, pass it on to my children
160 super.onMouseDown(mouse
);
164 * Handle mouse button releases.
166 * @param mouse mouse button release event
169 public void onMouseUp(final TMouseEvent mouse
) {
172 if (inSplitMove
&& mouse
.isMouse1()) {
178 // I didn't take it, pass it on to my children
179 super.onMouseUp(mouse
);
183 * Handle mouse movements.
185 * @param mouse mouse motion event
188 public void onMouseMotion(final TMouseEvent mouse
) {
191 if ((mouse
.getAbsoluteX() - getAbsoluteX() < 0)
192 || (mouse
.getAbsoluteX() - getAbsoluteX() >= getWidth())
193 || (mouse
.getAbsoluteY() - getAbsoluteY() < 0)
194 || (mouse
.getAbsoluteY() - getAbsoluteY() >= getHeight())
196 // Mouse has travelled out of my window.
202 split
= mouse
.getAbsoluteX() - getAbsoluteX();
203 split
= Math
.min(Math
.max(1, split
), getWidth() - 2);
205 split
= mouse
.getAbsoluteY() - getAbsoluteY();
206 split
= Math
.min(Math
.max(1, split
), getHeight() - 2);
212 // I didn't take it, pass it on to my children
213 super.onMouseMotion(mouse
);
216 // ------------------------------------------------------------------------
217 // TWidget ----------------------------------------------------------------
218 // ------------------------------------------------------------------------
225 CellAttributes attr
= getTheme().getColor("tsplitpane");
227 vLineXY(split
, 0, getHeight(), GraphicsChars
.WINDOW_SIDE
, attr
);
229 // Draw intersections of children
230 if ((left
instanceof TSplitPane
)
231 && (((TSplitPane
) left
).vertical
== false)
232 && (right
instanceof TSplitPane
)
233 && (((TSplitPane
) right
).vertical
== false)
234 && (((TSplitPane
) left
).split
== ((TSplitPane
) right
).split
)
236 putCharXY(split
, ((TSplitPane
) left
).split
, '\u253C', attr
);
238 if ((left
instanceof TSplitPane
)
239 && (((TSplitPane
) left
).vertical
== false)
241 putCharXY(split
, ((TSplitPane
) left
).split
, '\u2524', attr
);
243 if ((right
instanceof TSplitPane
)
244 && (((TSplitPane
) right
).vertical
== false)
246 putCharXY(split
, ((TSplitPane
) right
).split
, '\u251C',
252 && (mouse
.getAbsoluteX() == getAbsoluteX() + split
)
253 && (mouse
.getAbsoluteY() >= getAbsoluteY()) &&
254 (mouse
.getAbsoluteY() < getAbsoluteY() + getHeight())
256 putCharXY(split
, mouse
.getAbsoluteY() - getAbsoluteY(),
260 hLineXY(0, split
, getWidth(), GraphicsChars
.SINGLE_BAR
, attr
);
262 // Draw intersections of children
263 if ((top
instanceof TSplitPane
)
264 && (((TSplitPane
) top
).vertical
== true)
265 && (bottom
instanceof TSplitPane
)
266 && (((TSplitPane
) bottom
).vertical
== true)
267 && (((TSplitPane
) top
).split
== ((TSplitPane
) bottom
).split
)
269 putCharXY(((TSplitPane
) top
).split
, split
, '\u253C', attr
);
271 if ((top
instanceof TSplitPane
)
272 && (((TSplitPane
) top
).vertical
== true)
274 putCharXY(((TSplitPane
) top
).split
, split
, '\u2534', attr
);
276 if ((bottom
instanceof TSplitPane
)
277 && (((TSplitPane
) bottom
).vertical
== true)
279 putCharXY(((TSplitPane
) bottom
).split
, split
, '\u252C',
285 && (mouse
.getAbsoluteY() == getAbsoluteY() + split
)
286 && (mouse
.getAbsoluteX() >= getAbsoluteX()) &&
287 (mouse
.getAbsoluteX() < getAbsoluteX() + getWidth())
289 putCharXY(mouse
.getAbsoluteX() - getAbsoluteX(), split
,
297 * Generate a human-readable string for this widget.
299 * @return a human-readable string
302 public String
toString() {
303 return String
.format("%s(%8x) %s position (%d, %d) geometry %dx%d " +
304 "split %d left %s(%8x) right %s(%8x) top %s(%8x) bottom %s(%8x) " +
305 "active %s enabled %s visible %s", getClass().getName(),
306 hashCode(), (vertical ?
"VERTICAL" : "HORIZONTAL"),
307 getX(), getY(), getWidth(), getHeight(), split
,
308 (left
== null ?
"null" : left
.getClass().getName()),
309 (left
== null ?
0 : left
.hashCode()),
310 (right
== null ?
"null" : right
.getClass().getName()),
311 (right
== null ?
0 : right
.hashCode()),
312 (top
== null ?
"null" : top
.getClass().getName()),
313 (top
== null ?
0 : top
.hashCode()),
314 (bottom
== null ?
"null" : bottom
.getClass().getName()),
315 (bottom
== null ?
0 : bottom
.hashCode()),
316 isActive(), isEnabled(), isVisible());
319 // ------------------------------------------------------------------------
320 // TSplitPane -------------------------------------------------------------
321 // ------------------------------------------------------------------------
324 * Get the widget on the left side.
326 * @return the widget on the left, or null if not set
328 public TWidget
getLeft() {
333 * Set the widget on the left side.
335 * @param left the widget to set, or null to remove
337 public void setLeft(final TWidget left
) {
339 throw new IllegalArgumentException("cannot set left on " +
340 "horizontal split pane");
343 if (this.left
!= null) {
350 left
.setParent(this, false);
351 onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
, getWidth(),
356 * Get the widget on the right side.
358 * @return the widget on the right, or null if not set
360 public TWidget
getRight() {
365 * Set the widget on the right side.
367 * @param right the widget to set, or null to remove
369 public void setRight(final TWidget right
) {
371 throw new IllegalArgumentException("cannot set right on " +
372 "horizontal split pane");
375 if (this.right
!= null) {
382 right
.setParent(this, false);
383 onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
, getWidth(),
388 * Get the widget on the top side.
390 * @return the widget on the top, or null if not set
392 public TWidget
getTop() {
397 * Set the widget on the top side.
399 * @param top the widget to set, or null to remove
401 public void setTop(final TWidget top
) {
403 throw new IllegalArgumentException("cannot set top on vertical " +
407 if (this.top
!= null) {
414 top
.setParent(this, false);
415 onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
, getWidth(),
420 * Get the widget on the bottom side.
422 * @return the widget on the bottom, or null if not set
424 public TWidget
getBottom() {
429 * Set the widget on the bottom side.
431 * @param bottom the widget to set, or null to remove
433 public void setBottom(final TWidget bottom
) {
435 throw new IllegalArgumentException("cannot set bottom on " +
436 "vertical split pane");
438 if (bottom
== null) {
439 if (this.bottom
!= null) {
445 this.bottom
= bottom
;
446 bottom
.setParent(this, false);
447 onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
, getWidth(),
452 * Remove a widget, regardless of what pane it is on.
454 * @param widget the widget to remove
456 public void removeWidget(final TWidget widget
) {
457 if (widget
== null) {
458 throw new IllegalArgumentException("cannot remove null widget");
460 if (left
== widget
) {
462 assert(right
!= widget
);
463 assert(top
!= widget
);
464 assert(bottom
!= widget
);
467 if (right
== widget
) {
469 assert(left
!= widget
);
470 assert(top
!= widget
);
471 assert(bottom
!= widget
);
476 assert(left
!= widget
);
477 assert(right
!= widget
);
478 assert(bottom
!= widget
);
481 if (bottom
== widget
) {
483 assert(left
!= widget
);
484 assert(right
!= widget
);
485 assert(top
!= widget
);
488 throw new IllegalArgumentException("widget " + widget
+
489 " not in this split");
493 * Replace a widget, regardless of what pane it is on, with another
496 * @param oldWidget the widget to remove
497 * @param newWidget the widget to replace it with
499 public void replaceWidget(final TWidget oldWidget
,
500 final TWidget newWidget
) {
502 if (oldWidget
== null) {
503 throw new IllegalArgumentException("cannot remove null oldWidget");
505 if (left
== oldWidget
) {
507 assert(right
!= newWidget
);
508 assert(top
!= newWidget
);
509 assert(bottom
!= newWidget
);
512 if (right
== oldWidget
) {
514 assert(left
!= newWidget
);
515 assert(top
!= newWidget
);
516 assert(bottom
!= newWidget
);
519 if (top
== oldWidget
) {
521 assert(left
!= newWidget
);
522 assert(right
!= newWidget
);
523 assert(bottom
!= newWidget
);
526 if (bottom
== oldWidget
) {
527 setBottom(newWidget
);
528 assert(left
!= newWidget
);
529 assert(right
!= newWidget
);
530 assert(top
!= newWidget
);
533 throw new IllegalArgumentException("oldWidget " + oldWidget
+
534 " not in this split");
538 * Layout the two child widgets.
540 private void layoutChildren() {
543 left
.setDimensions(0, 0, split
, getHeight());
544 left
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
545 left
.getWidth(), left
.getHeight()));
548 right
.setDimensions(split
+ 1, 0, getWidth() - split
- 1,
550 right
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
551 right
.getWidth(), right
.getHeight()));
555 top
.setDimensions(0, 0, getWidth(), split
);
556 top
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
557 top
.getWidth(), top
.getHeight()));
559 if (bottom
!= null) {
560 bottom
.setDimensions(0, split
+ 1, getWidth(),
561 getHeight() - split
- 1);
562 bottom
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
,
563 bottom
.getWidth(), bottom
.getHeight()));
569 * Recenter the split to the middle of this split pane.
571 public void center() {
573 split
= getWidth() / 2;
575 split
= getHeight() / 2;
581 * Remove this split, removing the widget specified.
583 * @param widgetToRemove the widget to remove
584 * @param doClose if true, call the close() method before removing the
586 * @return the pane that remains, or null if nothing is retained
588 public TWidget
removeSplit(final TWidget widgetToRemove
,
589 final boolean doClose
) {
593 if ((widgetToRemove
!= left
) && (widgetToRemove
!= right
)) {
594 throw new IllegalArgumentException("widget to remove is not " +
595 "either of the panes in this splitpane");
597 if (widgetToRemove
== left
) {
604 if ((widgetToRemove
!= top
) && (widgetToRemove
!= bottom
)) {
605 throw new IllegalArgumentException("widget to remove is not " +
606 "either of the panes in this splitpane");
608 if (widgetToRemove
== top
) {
615 // Remove me from my parent widget.
616 TWidget myParent
= getParent();
620 if (myParent
instanceof TSplitPane
) {
621 // TSplitPane has a left/right/top/bottom link to me
622 // somewhere, remove it.
623 ((TSplitPane
) myParent
).removeWidget(this);
626 // Nothing is left of either pane. Remove me and bail out.
630 if (myParent
instanceof TSplitPane
) {
631 // TSplitPane has a left/right/top/bottom link to me
632 // somewhere, replace me with keep.
633 ((TSplitPane
) myParent
).replaceWidget(this, keep
);
635 keep
.setParent(myParent
, false);
636 keep
.setDimensions(getX(), getY(), getWidth(), getHeight());
637 keep
.onResize(new TResizeEvent(TResizeEvent
.Type
.WIDGET
, getWidth(),