| 1 | /* |
| 2 | * This file is part of lanterna (http://code.google.com/p/lanterna/). |
| 3 | * |
| 4 | * lanterna is free software: you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU Lesser General Public License as published by |
| 6 | * the Free Software Foundation, either version 3 of the License, or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU Lesser General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU Lesser General Public License |
| 15 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 16 | * |
| 17 | * Copyright (C) 2010-2015 Martin |
| 18 | */ |
| 19 | package com.googlecode.lanterna.gui2; |
| 20 | |
| 21 | /** |
| 22 | * This interface is the base part in the Lanterna Text GUI component hierarchy |
| 23 | * @author Martin |
| 24 | */ |
| 25 | public interface TextGUIElement { |
| 26 | /** |
| 27 | * Draws the GUI element using the supplied TextGUIGraphics object. This is the main method to implement when you |
| 28 | * want to create your own GUI components. |
| 29 | * @param graphics Graphics object to use when drawing the component |
| 30 | */ |
| 31 | void draw(TextGUIGraphics graphics); |
| 32 | |
| 33 | /** |
| 34 | * Checks if this element (or any of its child components, if any) has signaled that what it's currently displaying |
| 35 | * is out of date and needs re-drawing. |
| 36 | * @return {@code true} if the component is invalid and needs redrawing, {@code false} otherwise |
| 37 | */ |
| 38 | boolean isInvalid(); |
| 39 | } |