com.googlecode.lanterna.graphics.ThemeStyle 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;

import com.googlecode.lanterna.SGR;
import com.googlecode.lanterna.TextColor;

import java.util.EnumSet;

/**
 * ThemeStyle is the lowest entry in the theme hierarchy, containing the actual colors and SGRs to use. When drawing a
 * component, you would pick out a {@link ThemeDefinition} that applies to the whole component and then choose to
 * activate individual {@link ThemeStyle}s when drawing the different parts of the component.
 * @author Martin
 */
public interface ThemeStyle {
    /**
     * Returns the foreground color associated with this style
     * @return foreground color associated with this style
     */
    TextColor getForeground();

    /**
     * Returns the background color associated with this style
     * @return background color associated with this style
     */
    TextColor getBackground();

    /**
     * Returns the set of SGR flags associated with this style. This {@code EnumSet} is either unmodifiable or a copy so
     * altering it will not change the theme in any way.
     * @return SGR flags associated with this style
     */
    EnumSet getSGRs();
}