Merge branch 'upstream-sep2019-tcombo' into subtree
[fanfix.git] / layout / LayoutManager.java
1 /*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (C) 2019 Kevin Lamonte
7 *
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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.
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29 package jexer.layout;
30
31 import jexer.TWidget;
32 import jexer.event.TResizeEvent;
33
34 /**
35 * A LayoutManager provides automatic positioning and sizing of a TWidget's
36 * child TWidgets.
37 */
38 public interface LayoutManager {
39
40 /**
41 * Process the parent widget's resize event, and resize/reposition child
42 * widgets.
43 *
44 * @param resize resize event
45 */
46 public void onResize(final TResizeEvent resize);
47
48 /**
49 * Add a child widget to manage.
50 *
51 * @param child the widget to manage
52 */
53 public void add(final TWidget child);
54
55 /**
56 * Remove a child widget from those managed by this LayoutManager.
57 *
58 * @param child the widget to remove
59 */
60 public void remove(final TWidget child);
61
62 /**
63 * Reset a child widget's original/preferred size.
64 *
65 * @param child the widget to manage
66 */
67 public void resetSize(final TWidget child);
68
69 }