X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fjexer%2Fbits%2FCellAttributes.java;h=e889e89250c14dcb608bb7fa35132fc89d6b0c1f;hb=e16dda65585466c8987bd1efd718431450a96605;hp=5bfa847e8cbe57c3dda6ff8e169e998a4693cbcb;hpb=624ce48ecf9a314771bd8f1616d8035b0253d8a0;p=nikiroo-utils.git diff --git a/src/jexer/bits/CellAttributes.java b/src/jexer/bits/CellAttributes.java index 5bfa847..e889e89 100644 --- a/src/jexer/bits/CellAttributes.java +++ b/src/jexer/bits/CellAttributes.java @@ -1,34 +1,30 @@ -/** +/* * Jexer - Java Text User Interface * - * Version: $Id$ - * - * Author: Kevin Lamonte, kevin.lamonte@gmail.com - * - * License: LGPLv3 or later + * The MIT License (MIT) * - * Copyright: 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. + * Copyright (C) 2016 Kevin Lamonte * - * Copyright (C) 2015 Kevin Lamonte + * 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 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. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. * - * 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 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. * - * 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 + * @author Kevin Lamonte [kevin.lamonte@gmail.com] + * @version 1 */ package jexer.bits; @@ -38,164 +34,262 @@ package jexer.bits; public class CellAttributes { /** - * Bold + * Bold attribute. + */ + private boolean bold; + + /** + * Getter for bold. + * + * @return bold value + */ + public final boolean isBold() { + return bold; + } + + /** + * Setter for bold. + * + * @param bold new bold value + */ + public final void setBold(final boolean bold) { + this.bold = bold; + } + + /** + * Blink attribute. */ - public boolean bold; + private boolean blink; /** - * Blink + * Getter for blink. + * + * @return blink value */ - public boolean blink; + public final boolean isBlink() { + return blink; + } /** - * Reverse + * Setter for blink. + * + * @param blink new blink value */ - public boolean reverse; + public final void setBlink(final boolean blink) { + this.blink = blink; + } /** - * Underline + * Reverse attribute. */ - public boolean underline; + private boolean reverse; /** - * Protected + * Getter for reverse. + * + * @return reverse value */ - public boolean protect; + public final boolean isReverse() { + return reverse; + } + + /** + * Setter for reverse. + * + * @param reverse new reverse value + */ + public final void setReverse(final boolean reverse) { + this.reverse = reverse; + } + + /** + * Underline attribute. + */ + private boolean underline; + + /** + * Getter for underline. + * + * @return underline value + */ + public final boolean isUnderline() { + return underline; + } + + /** + * Setter for underline. + * + * @param underline new underline value + */ + public final void setUnderline(final boolean underline) { + this.underline = underline; + } + + /** + * Protected attribute. + */ + private boolean protect; + + /** + * Getter for protect. + * + * @return protect value + */ + public final boolean isProtect() { + return protect; + } + + /** + * Setter for protect. + * + * @param protect new protect value + */ + public final void setProtect(final boolean protect) { + this.protect = protect; + } /** * Foreground color. Color.WHITE, Color.RED, etc. */ - public Color foreColor; + private Color foreColor; + + /** + * Getter for foreColor. + * + * @return foreColor value + */ + public final Color getForeColor() { + return foreColor; + } + + /** + * Setter for foreColor. + * + * @param foreColor new foreColor value + */ + public final void setForeColor(final Color foreColor) { + this.foreColor = foreColor; + } /** * Background color. Color.WHITE, Color.RED, etc. */ - public Color backColor; + private Color backColor; + + /** + * Getter for backColor. + * + * @return backColor value + */ + public final Color getBackColor() { + return backColor; + } + + /** + * Setter for backColor. + * + * @param backColor new backColor value + */ + public final void setBackColor(final Color backColor) { + this.backColor = backColor; + } /** - * Set to default not-bold, white foreground on black background. + * Set to default: white foreground on black background, no + * bold/underline/blink/rever/protect. */ public void reset() { - bold = false; - blink = false; - reverse = false; - protect = false; - underline = false; - foreColor = Color.WHITE; - backColor = Color.BLACK; + bold = false; + blink = false; + reverse = false; + underline = false; + protect = false; + foreColor = Color.WHITE; + backColor = Color.BLACK; } /** - * Public constructor + * Public constructor sets default values of the cell to white-on-black, + * no bold/blink/reverse/underline/protect. + * + * @see #reset() */ public CellAttributes() { - reset(); + reset(); } /** - * Comparison. All fields must match to return true. + * Comparison check. All fields must match to return true. + * + * @param rhs another CellAttributes instance + * @return true if all fields are equal */ @Override - public boolean equals(Object rhs) { - if (!(rhs instanceof CellAttributes)) { - return false; - } - - CellAttributes that = (CellAttributes)rhs; - return ((bold == that.bold) && - (blink == that.blink) && - (reverse == that.reverse) && - (underline == that.underline) && - (protect == that.protect) && - (foreColor == that.foreColor) && - (backColor == that.backColor)); - } - - /** - * Set my field values to that's field - */ - public void setTo(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; - } - - /** - * Convert enum to string - * - * @param color Color.RED, Color.BLUE, etc. - * @return "red", "blue", etc. - */ - static public String stringFromColor(Color color) { - if (color.equals(Color.BLACK)) { - return "black"; - } else if (color.equals(Color.WHITE)) { - return "white"; - } else if (color.equals(Color.RED)) { - return "red"; - } else if (color.equals(Color.CYAN)) { - return "cyan"; - } else if (color.equals(Color.GREEN)) { - return "green"; - } else if (color.equals(Color.MAGENTA)) { - return "magenta"; - } else if (color.equals(Color.BLUE)) { - return "blue"; - } else if (color.equals(Color.YELLOW)) { - return "yellow"; - } - throw new IllegalArgumentException("Invalid Color value: " + - color.value); - } - - /** - * Convert string to enum - * - * @param color "red", "blue", etc. - * @return Color.RED, Color.BLUE, etc. - */ - static private Color colorFromString(String color) { - switch (color.toLowerCase()) { - case "black": - return Color.BLACK; - case "white": - return Color.WHITE; - case "red": - return Color.RED; - case "cyan": - return Color.CYAN; - case "green": - return Color.GREEN; - case "magenta": - return Color.MAGENTA; - case "blue": - return Color.BLUE; - case "yellow": - return Color.YELLOW; - case "brown": - return Color.YELLOW; - default: - // Let unknown strings become white - return Color.WHITE; - } - } - - /** - * Make human-readable description of this CellAttributes + public boolean equals(final Object rhs) { + if (!(rhs instanceof CellAttributes)) { + return false; + } + + CellAttributes that = (CellAttributes) rhs; + return ((bold == that.bold) + && (blink == that.blink) + && (reverse == that.reverse) + && (underline == that.underline) + && (protect == that.protect) + && (foreColor == that.foreColor) + && (backColor == that.backColor)); + } + + /** + * Hashcode uses all fields in equals(). + * + * @return the hash + */ + @Override + public int hashCode() { + int A = 13; + int B = 23; + int hash = A; + hash = (B * hash) + (bold ? 1 : 0); + hash = (B * hash) + (blink ? 1 : 0); + hash = (B * hash) + (underline ? 1 : 0); + hash = (B * hash) + (reverse ? 1 : 0); + hash = (B * hash) + (protect ? 1 : 0); + hash = (B * hash) + foreColor.hashCode(); + hash = (B * hash) + backColor.hashCode(); + return hash; + } + + /** + * Set my field values to that's field. + * + * @param rhs another CellAttributes instance + */ + 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; + } + + /** + * Make human-readable description of this CellAttributes. + * + * @return displayable String */ @Override public String toString() { - return String.format("%s%s on %s", - bold ? "bold " : "", - stringFromColor(foreColor), - stringFromColor(backColor)); + if (bold) { + return String.format("bold %s on %s", + foreColor, backColor); + } else { + return String.format("%s on %s", foreColor, backColor); + } } } -