/*
- * Sixth 3D engine. Author: Svjatoslav Agejenko.
+ * Sixth 3D engine. Author: Svjatoslav Agejenko.
* This project is released under Creative Commons Zero (CC0) license.
*/
package eu.svjatoslav.sixth.e3d.gui;
/**
- * A pointer to a character in a text.
+ * A pointer to a character in a text using row and column.
+ * <p>
+ * It can be used to represent a cursor position in a text.
+ * Also, it can be used to represent beginning and end of a selection.
*/
public class TextPointer implements Comparable<TextPointer> {
+ /**
+ * The row of the character. Starts from 0.
+ */
public int row;
+
+ /**
+ * The column of the character. Starts from 0.
+ */
public int column;
public TextPointer() {
/**
* Checks if this pointer is between the specified pointers.
*
- * @param start
- * The start pointer.
- * @param end
- * The end pointer.
+ * @param start The start pointer.
+ * @param end The end pointer.
* @return True if this pointer is between the specified pointers.
*/
public boolean isBetween(final TextPointer start, final TextPointer end) {