/**
* Jexer - Java Text User Interface
*
- * Version: $Id$
- *
- * Author: Kevin Lamonte, <a href="mailto:kevin.lamonte@gmail.com">kevin.lamonte@gmail.com</a>
- *
* License: LGPLv3 or later
*
- * 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.
+ * 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) 2015 Kevin Lamonte
*
* 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;
/**
- * A single text cell on the screen
+ * This class represents a single text cell on the screen.
*/
public class Cell extends CellAttributes {
/**
- * The character at this cell
+ * The character at this cell.
+ */
+ private char ch;
+
+ /**
+ * Getter for cell character.
+ *
+ * @return cell character
+ */
+ public final char getChar() {
+ return ch;
+ }
+
+ /**
+ * Setter for cell character.
+ *
+ * @param ch new cell character
*/
- public char ch;
+ public final void setChar(final char ch) {
+ this.ch = ch;
+ }
/**
- * Reset this cell to a blank
+ * Reset this cell to a blank.
*/
@Override
- public void reset() {
- super.reset();
- ch = ' ';
+ public final void reset() {
+ super.reset();
+ ch = ' ';
}
/**
- * Returns true if this cell has default attributes
+ * Check to see if this cell has default attributes: white foreground,
+ * black background, no bold/blink/reverse/underline/protect, and a
+ * character value of ' ' (space).
+ *
+ * @return true if this cell has default attributes.
*/
- public boolean isBlank() {
- if ((foreColor.equals(Color.WHITE)) &&
- (backColor.equals(Color.BLACK)) &&
- (bold == false) &&
- (blink == false) &&
- (reverse == false) &&
- (underline == false) &&
- (protect == false) &&
- (ch == ' ')) {
- return true;
- }
+ public final boolean isBlank() {
+ if ((getForeColor().equals(Color.WHITE))
+ && (getBackColor().equals(Color.BLACK))
+ && !getBold()
+ && !getBlink()
+ && !getReverse()
+ && !getUnderline()
+ && !getProtect()
+ && (ch == ' ')
+ ) {
+ return true;
+ }
- return false;
+ return false;
}
/**
- * Comparison. All fields must match to return true.
+ * Comparison check. All fields must match to return true.
+ *
+ * @param rhs another Cell instance
+ * @return true if all fields are equal
*/
@Override
- public boolean equals(Object rhs) {
- if (!(rhs instanceof Cell)) {
- return false;
- }
+ public final boolean equals(final Object rhs) {
+ if (!(rhs instanceof Cell)) {
+ return false;
+ }
- Cell that = (Cell)rhs;
- return (super.equals(rhs) &&
- (ch == that.ch));
+ Cell that = (Cell) rhs;
+ return (super.equals(rhs)
+ && (ch == that.ch));
}
/**
- * Set my field values to that's field
+ * Set my field values to that's field.
+ *
+ * @param rhs an instance of either Cell or CellAttributes
*/
@Override
- public void setTo(Object rhs) {
- CellAttributes thatAttr = (CellAttributes)rhs;
- super.setTo(thatAttr);
+ public final void setTo(final Object rhs) {
+ // Let this throw a ClassCastException
+ CellAttributes thatAttr = (CellAttributes) rhs;
+ super.setTo(thatAttr);
- if (rhs instanceof Cell) {
- Cell that = (Cell)rhs;
- this.ch = that.ch;
- }
+ if (rhs instanceof Cell) {
+ Cell that = (Cell) rhs;
+ this.ch = that.ch;
+ }
}
/**
- * Set my field attr values to that's field
+ * Set my field attr values to that's field.
+ *
+ * @param that a CellAttributes instance
*/
- public void setAttr(CellAttributes that) {
- super.setTo(that);
+ public final void setAttr(final CellAttributes that) {
+ super.setTo(that);
}
/**
- * Public constructor
+ * Public constructor sets default values of the cell to blank.
+ *
+ * @see #isBlank()
+ * @see #reset()
*/
public Cell() {
- reset();
+ reset();
}
/**
- * Public constructor
+ * Public constructor sets the character. Attributes are the same as
+ * default.
*
* @param ch character to set to
+ * @see #reset()
*/
- public Cell(char ch) {
- reset();
- this.ch = ch;
+ public Cell(final char ch) {
+ reset();
+ this.ch = ch;
}
/**
- * Make human-readable description of this Cell
+ * Make human-readable description of this Cell.
+ *
+ * @return displayable String
*/
@Override
- public String toString() {
- return String.format("fore: %d back: %d bold: %s blink: %s ch %c",
- foreColor, backColor, bold, blink, ch);
+ public final String toString() {
+ return String.format("fore: %d back: %d bold: %s blink: %s ch %c",
+ getForeColor(), getBackColor(), getBold(), getBlink(), ch);
}
}
-
git://git.nikiroo.be / fanfix.git / blobdiff