com.googlecode.lanterna.graphics.ThemedTextGraphics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lanterna Show documentation

Java library for creating text-based terminal GUIs

There is a newer version: 3.2.0-alpha1

/*
 * This file is part of lanterna (http://code.google.com/p/lanterna/).
 *
 * lanterna is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * Copyright (C) 2010-2020 Martin Berglund
 */
package com.googlecode.lanterna.graphics;

/**
 * Expanded TextGraphics that adds methods to interact with themes
 * @author Martin
 */
public interface ThemedTextGraphics extends TextGraphics {
    /**
     * Returns the {@code Theme} object active on this {@code ThemedTextGraphics}
     * @return Active {@code Theme} object
     * @deprecated Use the {@link Theme} attached to each component instead
     */
    @Deprecated
    Theme getTheme();

    /**
     * Retrieves the ThemeDefinition associated with the class parameter passed in. The implementation should make sure
     * that there is always a fallback available if there's no direct definition for this class; the method should never
     * return null.
     * @param clazz Class to search ThemeDefinition for
     * @return ThemeDefinition that was resolved for this class
     * @deprecated Use the {@link Theme} attached to each component instead
     */
    @Deprecated
    ThemeDefinition getThemeDefinition(Class clazz);

    /**
     * Takes a ThemeStyle as applies it to this TextGraphics. This will effectively set the foreground color, the
     * background color and all the SGRs.
     * @param themeStyle ThemeStyle to apply
     * @return Itself
     */
    ThemedTextGraphics applyThemeStyle(ThemeStyle themeStyle);
}