src/com/googlecode/lanterna/gui2/Border.java

   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 import com.googlecode.lanterna.TerminalPosition;
  22 import com.googlecode.lanterna.TerminalSize;
  23
  24 /**
  25  * Main interface for different border classes, with additional methods to help lanterna figure out the size and offset
  26  * of components wrapped by borders.
  27  * @author Martin
  28  */
  29 public interface Border extends Container, Composite {
  30     interface BorderRenderer extends ComponentRenderer<Border> {
  31         /**
  32          * How large is the offset from the top left corner of the border to the top left corner of the wrapped component?
  33          * @return Position of the wrapped components top left position, relative to the top left corner of the border
  34          */
  35         TerminalPosition getWrappedComponentTopLeftOffset();
  36
  37         /**
  38          * Given a total size of the border composite and it's wrapped component, how large would the actual wrapped
  39          * component be?
  40          * @param borderSize Size to calculate for, this should be the total size of the border and the inner component
  41          * @return Size of the inner component if the total size of inner + border is borderSize
  42          */
  43         TerminalSize getWrappedComponentSize(TerminalSize borderSize);
  44     }
  45 }