Module com.googlecode.lanterna
Package com.googlecode.lanterna.terminal.swing

Class TerminalEmulatorPalette

  • public class TerminalEmulatorPalette
extends java.lang.Object
    This class specifies the palette of colors the terminal will use for the normally available 8 + 1 ANSI colors but also their 'bright' versions with are normally enabled through bold mode. There are several palettes available, all based on popular terminal emulators. All colors are defined in the AWT format.

    • Field Detail

      • GNOME_TERMINAL

        public static final TerminalEmulatorPalette GNOME_TERMINAL
        Values taken from gnome-terminal on Ubuntu

      • WINDOWS_XP_COMMAND_PROMPT

        public static final TerminalEmulatorPalette WINDOWS_XP_COMMAND_PROMPT
        Values taken from wikipedia, these are supposed to be what Windows XP cmd is using.

      • MAC_OS_X_TERMINAL_APP

        public static final TerminalEmulatorPalette MAC_OS_X_TERMINAL_APP
        Values taken from wikipedia, these are supposed to be what terminal.app on MacOSX is using.

      • DEFAULT

        public static final TerminalEmulatorPalette DEFAULT
        Default colors the SwingTerminal is using if you don't specify anything

      • defaultColor

        private final java.awt.Color defaultColor

      • defaultBrightColor

        private final java.awt.Color defaultBrightColor

      • defaultBackgroundColor

        private final java.awt.Color defaultBackgroundColor

      • normalBlack

        private final java.awt.Color normalBlack

      • brightBlack

        private final java.awt.Color brightBlack

      • normalRed

        private final java.awt.Color normalRed

      • brightRed

        private final java.awt.Color brightRed

      • normalGreen

        private final java.awt.Color normalGreen

      • brightGreen

        private final java.awt.Color brightGreen

      • normalYellow

        private final java.awt.Color normalYellow

      • brightYellow

        private final java.awt.Color brightYellow

      • normalBlue

        private final java.awt.Color normalBlue

      • brightBlue

        private final java.awt.Color brightBlue

      • normalMagenta

        private final java.awt.Color normalMagenta

      • brightMagenta

        private final java.awt.Color brightMagenta

      • normalCyan

        private final java.awt.Color normalCyan

      • brightCyan

        private final java.awt.Color brightCyan

      • normalWhite

        private final java.awt.Color normalWhite

      • brightWhite

        private final java.awt.Color brightWhite

    • Constructor Detail

      • TerminalEmulatorPalette

        public TerminalEmulatorPalette​(java.awt.Color defaultColor,
                               java.awt.Color defaultBrightColor,
                               java.awt.Color defaultBackgroundColor,
                               java.awt.Color normalBlack,
                               java.awt.Color brightBlack,
                               java.awt.Color normalRed,
                               java.awt.Color brightRed,
                               java.awt.Color normalGreen,
                               java.awt.Color brightGreen,
                               java.awt.Color normalYellow,
                               java.awt.Color brightYellow,
                               java.awt.Color normalBlue,
                               java.awt.Color brightBlue,
                               java.awt.Color normalMagenta,
                               java.awt.Color brightMagenta,
                               java.awt.Color normalCyan,
                               java.awt.Color brightCyan,
                               java.awt.Color normalWhite,
                               java.awt.Color brightWhite)
        Creates a new palette with all colors specified up-front
        Parameters:
        defaultColor - Default color which no specific color has been selected
        defaultBrightColor - Default color which no specific color has been selected but bold is enabled
        defaultBackgroundColor - Default color to use for the background when no specific color has been selected
        normalBlack - Color for normal black
        brightBlack - Color for bright black
        normalRed - Color for normal red
        brightRed - Color for bright red
        normalGreen - Color for normal green
        brightGreen - Color for bright green
        normalYellow - Color for normal yellow
        brightYellow - Color for bright yellow
        normalBlue - Color for normal blue
        brightBlue - Color for bright blue
        normalMagenta - Color for normal magenta
        brightMagenta - Color for bright magenta
        normalCyan - Color for normal cyan
        brightCyan - Color for bright cyan
        normalWhite - Color for normal white
        brightWhite - Color for bright white

    • Method Detail

      • get

        public java.awt.Color get​(TextColor.ANSI color,
                          boolean isForeground,
                          boolean useBrightTones)
        Returns the AWT color from this palette given an ANSI color and two hints for if we are looking for a background color and if we want to use the bright version.
        Parameters:
        color - Which ANSI color we want to extract
        isForeground - Is this color we extract going to be used as a background color?
        useBrightTones - If true, we should return the bright version of the color
        Returns:
        AWT color extracted from this palette for the input parameters

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object