src/com/googlecode/lanterna/graphics/ThemedTextGraphics.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.graphics;
  20
  21 /**
  22  * Expanded TextGraphics that adds methods to interact with themes
  23  * @author Martin
  24  */
  25 public interface ThemedTextGraphics extends TextGraphics {
  26     /**
  27      * Returns the {@code Theme} object active on this {@code ThemedTextGraphics}
  28      * @return Active {@code Theme} object
  29      */
  30     Theme getTheme();
  31
  32     /**
  33      * Retrieves the ThemeDefinition associated with the class parameter passed in. The implementation should make sure
  34      * that there is always a fallback available if there's no direct definition for this class; the method should never
  35      * return null.
  36      * @param clazz Class to search ThemeDefinition for
  37      * @return ThemeDefinition that was resolved for this class
  38      */
  39     ThemeDefinition getThemeDefinition(Class<?> clazz);
  40
  41     /**
  42      * Takes a ThemeStyle as applies it to this TextGraphics. This will effectively set the foreground color, the
  43      * background color and all the SGRs.
  44      * @param themeStyle ThemeStyle to apply
  45      * @return Itself
  46      */
  47     ThemedTextGraphics applyThemeStyle(ThemeStyle themeStyle);
  48 }