Package com.googlecode.lanterna

Class TerminalRectangle

java.lang.Object

com.googlecode.lanterna.TerminalRectangle

public class TerminalRectangle
extends Object

This class is immutable and cannot change its internal state after creation.

Author:

ginkoblongata

Field Summary

Fields

Modifier and Type	Field	Description
int	height
TerminalPosition	position
TerminalSize	size
int	width
int	x
int	xAndWidth
int	y
int	yAndHeight

Constructor Summary

Constructors

Constructor	Description
TerminalRectangle(int x, int y, int width, int height)	Creates a new terminal rect representation at the supplied x y position with the supplied width and height.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getColumns()
int	getRows()
int	hashCode()
String	toString()
boolean	whenContains(int x, int y, Runnable op)
boolean	whenContains(TerminalPosition p, Runnable op)
TerminalRectangle	withColumns(int columns)	Creates a new rect based on this rect, but with a different width
TerminalRectangle	withRows(int rows)	Creates a new rect based on this rect, but with a different height

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

position

public final TerminalPosition position

size

public final TerminalSize size

x

public final int x

y

public final int y

width

public final int width

height

public final int height

xAndWidth

public final int xAndWidth

yAndHeight

public final int yAndHeight

Constructor Detail

TerminalRectangle

public TerminalRectangle(int x,
                         int y,
                         int width,
                         int height)

Creates a new terminal rect representation at the supplied x y position with the supplied width and height. Both width and height must be at least zero (non negative) as checked in TerminalSize.

Parameters:

width - number of columns

height - number of rows

Method Detail

getColumns

public int getColumns()

Returns:

Returns the width of this rect, in number of columns

getRows

public int getRows()

Returns:

Returns the height of this rect representation, in number of rows

withColumns

public TerminalRectangle withColumns(int columns)

Creates a new rect based on this rect, but with a different width

Parameters:

columns - Width of the new rect, in columns

Returns:

New rect based on this one, but with a new width

withRows

public TerminalRectangle withRows(int rows)

Creates a new rect based on this rect, but with a different height

Parameters:

rows - Height of the new rect, in rows

Returns:

New rect based on this one, but with a new height

whenContains

public boolean whenContains(TerminalPosition p,
                            Runnable op)

whenContains

public boolean whenContains(int x,
                            int y,
                            Runnable op)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object