-/**
+/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
- *
- * This module is licensed under the GNU Lesser General Public License
- * Version 3. Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * The MIT License (MIT)
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
*
- * This program 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.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * 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
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
* @author Kevin Lamonte [kevin.lamonte@gmail.com]
* @version 1
*/
public class CellAttributes {
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Bold attribute.
*/
private boolean bold;
+ /**
+ * Blink attribute.
+ */
+ private boolean blink;
+
+ /**
+ * Reverse attribute.
+ */
+ private boolean reverse;
+
+ /**
+ * Underline attribute.
+ */
+ private boolean underline;
+
+ /**
+ * Protected attribute.
+ */
+ private boolean protect;
+
+ /**
+ * Foreground color. Color.WHITE, Color.RED, etc.
+ */
+ private Color foreColor;
+
+ /**
+ * Background color. Color.WHITE, Color.RED, etc.
+ */
+ private Color backColor;
+
+ /**
+ * Foreground color as 24-bit RGB value. Negative value means not set.
+ */
+ private int foreColorRGB = -1;
+
+ /**
+ * Background color as 24-bit RGB value. Negative value means not set.
+ */
+ private int backColorRGB = -1;
+
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Public constructor sets default values of the cell to white-on-black,
+ * no bold/blink/reverse/underline/protect.
+ *
+ * @see #reset()
+ */
+ public CellAttributes() {
+ reset();
+ }
+
+ /**
+ * Public constructor makes a copy from another instance.
+ *
+ * @param that another CellAttributes instance
+ * @see #reset()
+ */
+ public CellAttributes(final CellAttributes that) {
+ setTo(that);
+ }
+
+ // ------------------------------------------------------------------------
+ // CellAttributes ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Getter for bold.
*
* @return bold value
*/
- public final boolean getBold() {
+ public final boolean isBold() {
return bold;
}
this.bold = bold;
}
- /**
- * Blink attribute.
- */
- private boolean blink;
-
/**
* Getter for blink.
*
* @return blink value
*/
- public final boolean getBlink() {
+ public final boolean isBlink() {
return blink;
}
this.blink = blink;
}
- /**
- * Reverse attribute.
- */
- private boolean reverse;
-
/**
* Getter for reverse.
*
* @return reverse value
*/
- public final boolean getReverse() {
+ public final boolean isReverse() {
return reverse;
}
this.reverse = reverse;
}
- /**
- * Underline attribute.
- */
- private boolean underline;
-
/**
* Getter for underline.
*
* @return underline value
*/
- public final boolean getUnderline() {
+ public final boolean isUnderline() {
return underline;
}
this.underline = underline;
}
- /**
- * Protected attribute.
- */
- private boolean protect;
-
/**
* Getter for protect.
*
* @return protect value
*/
- public final boolean getProtect() {
+ public final boolean isProtect() {
return protect;
}
this.protect = protect;
}
- /**
- * Foreground color. Color.WHITE, Color.RED, etc.
- */
- private Color foreColor;
-
/**
* Getter for foreColor.
*
this.foreColor = foreColor;
}
- /**
- * Background color. Color.WHITE, Color.RED, etc.
- */
- private Color backColor;
-
/**
* Getter for backColor.
*
}
/**
- * Set to default: white foreground on black background, no
- * bold/underline/blink/rever/protect.
+ * Getter for foreColor RGB.
+ *
+ * @return foreColor value. Negative means unset.
*/
- public void reset() {
- bold = false;
- blink = false;
- reverse = false;
- underline = false;
- protect = false;
- foreColor = Color.WHITE;
- backColor = Color.BLACK;
+ public final int getForeColorRGB() {
+ return foreColorRGB;
}
/**
- * Public constructor sets default values of the cell to white-on-black,
- * no bold/blink/reverse/underline/protect.
+ * Setter for foreColor RGB.
*
- * @see #reset()
+ * @param foreColorRGB new foreColor RGB value
*/
- public CellAttributes() {
- reset();
+ public final void setForeColorRGB(final int foreColorRGB) {
+ this.foreColorRGB = foreColorRGB;
+ }
+
+ /**
+ * Getter for backColor RGB.
+ *
+ * @return backColor value. Negative means unset.
+ */
+ public final int getBackColorRGB() {
+ return backColorRGB;
+ }
+
+ /**
+ * Setter for backColor RGB.
+ *
+ * @param backColorRGB new backColor RGB value
+ */
+ public final void setBackColorRGB(final int backColorRGB) {
+ this.backColorRGB = backColorRGB;
+ }
+
+ /**
+ * See if this cell uses RGB or ANSI colors.
+ *
+ * @return true if this cell has a RGB color
+ */
+ public final boolean isRGB() {
+ return (foreColorRGB >= 0) || (backColorRGB >= 0);
+ }
+
+ /**
+ * Set to default: white foreground on black background, no
+ * bold/underline/blink/rever/protect.
+ */
+ public void reset() {
+ bold = false;
+ blink = false;
+ reverse = false;
+ underline = false;
+ protect = false;
+ foreColor = Color.WHITE;
+ backColor = Color.BLACK;
+ foreColorRGB = -1;
+ backColorRGB = -1;
}
/**
}
CellAttributes that = (CellAttributes) rhs;
- return ((bold == that.bold)
- && (blink == that.blink)
+ return ((foreColor == that.foreColor)
+ && (backColor == that.backColor)
+ && (foreColorRGB == that.foreColorRGB)
+ && (backColorRGB == that.backColorRGB)
+ && (bold == that.bold)
&& (reverse == that.reverse)
&& (underline == that.underline)
- && (protect == that.protect)
- && (foreColor == that.foreColor)
- && (backColor == that.backColor));
+ && (blink == that.blink)
+ && (protect == that.protect));
}
/**
hash = (B * hash) + (protect ? 1 : 0);
hash = (B * hash) + foreColor.hashCode();
hash = (B * hash) + backColor.hashCode();
+ hash = (B * hash) + foreColorRGB;
+ hash = (B * hash) + backColorRGB;
return hash;
}
public void setTo(final Object rhs) {
CellAttributes that = (CellAttributes) rhs;
- this.bold = that.bold;
- this.blink = that.blink;
- this.reverse = that.reverse;
- this.underline = that.underline;
- this.protect = that.protect;
- this.foreColor = that.foreColor;
- this.backColor = that.backColor;
+ this.bold = that.bold;
+ this.blink = that.blink;
+ this.reverse = that.reverse;
+ this.underline = that.underline;
+ this.protect = that.protect;
+ this.foreColor = that.foreColor;
+ this.backColor = that.backColor;
+ this.foreColorRGB = that.foreColorRGB;
+ this.backColorRGB = that.backColorRGB;
}
/**
*/
@Override
public String toString() {
- if (bold) {
- return String.format("bold %s on %s",
- foreColor, backColor);
- } else {
- return String.format("%s on %s", foreColor, backColor);
+ if ((foreColorRGB >= 0) || (backColorRGB >= 0)) {
+ return String.format("RGB: #%06x on #%06x",
+ (foreColorRGB & 0xFFFFFF),
+ (backColorRGB & 0xFFFFFF));
}
+ return String.format("%s%s%s on %s", (bold == true ? "bold " : ""),
+ (blink == true ? "blink " : ""), foreColor, backColor);
}
}