- java.lang.Object
-
- com.googlecode.lanterna.gui2.Borders
-
public class Borders extends java.lang.Object
This class containers a couple of border implementation and utility methods for instantiating them. It also contains a utility method for joining border line graphics together with adjacent lines so they blend in together:joinLinesWithFrame(..)
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
Borders.AbstractBorderRenderer
private static class
Borders.BorderStyle
private static class
Borders.DoubleLine
private static class
Borders.DoubleLineRenderer
private static class
Borders.SingleLine
private static class
Borders.SingleLineRenderer
private static class
Borders.StandardBorder
-
Constructor Summary
Constructors Modifier Constructor Description private
Borders()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Border
doubleLine()
Creates aBorder
that is drawn as a solid color double line surrounding the wrapped componentstatic Border
doubleLine(java.lang.String title)
Creates aBorder
that is drawn as a solid color double line surrounding the wrapped component with a title string normally drawn at the top-left sidestatic Border
doubleLineBevel()
Creates aBorder
that is drawn as a bevel color double line surrounding the wrapped componentstatic Border
doubleLineBevel(java.lang.String title)
Creates aBorder
that is drawn as a bevel color double line surrounding the wrapped component with a title string normally drawn at the top-left sidestatic Border
doubleLineReverseBevel()
Creates aBorder
that is drawn as a reverse bevel color double line surrounding the wrapped componentstatic Border
doubleLineReverseBevel(java.lang.String title)
Creates aBorder
that is drawn as a reverse bevel color double line surrounding the wrapped component with a title string normally drawn at the top-left sidestatic void
joinLinesWithFrame(TextGraphics graphics)
This method will attempt to join line drawing characters with the outermost bottom and top rows and left and right columns.static Border
singleLine()
Creates aBorder
that is drawn as a solid color single line surrounding the wrapped componentstatic Border
singleLine(java.lang.String title)
Creates aBorder
that is drawn as a solid color single line surrounding the wrapped component with a title string normally drawn at the top-left sidestatic Border
singleLineBevel()
Creates aBorder
that is drawn as a bevel color single line surrounding the wrapped componentstatic Border
singleLineBevel(java.lang.String title)
Creates aBorder
that is drawn as a bevel color single line surrounding the wrapped component with a title string normally drawn at the top-left sidestatic Border
singleLineReverseBevel()
Creates aBorder
that is drawn as a reverse bevel color single line surrounding the wrapped componentstatic Border
singleLineReverseBevel(java.lang.String title)
Creates aBorder
that is drawn as a reverse bevel color single line surrounding the wrapped component with a title string normally drawn at the top-left side
-
-
-
Method Detail
-
singleLine
public static Border singleLine()
Creates aBorder
that is drawn as a solid color single line surrounding the wrapped component- Returns:
- New solid color single line
Border
-
singleLine
public static Border singleLine(java.lang.String title)
Creates aBorder
that is drawn as a solid color single line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New solid color single line
Border
with a title
-
singleLineBevel
public static Border singleLineBevel()
Creates aBorder
that is drawn as a bevel color single line surrounding the wrapped component- Returns:
- New bevel color single line
Border
-
singleLineBevel
public static Border singleLineBevel(java.lang.String title)
Creates aBorder
that is drawn as a bevel color single line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New bevel color single line
Border
with a title
-
singleLineReverseBevel
public static Border singleLineReverseBevel()
Creates aBorder
that is drawn as a reverse bevel color single line surrounding the wrapped component- Returns:
- New reverse bevel color single line
Border
-
singleLineReverseBevel
public static Border singleLineReverseBevel(java.lang.String title)
Creates aBorder
that is drawn as a reverse bevel color single line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New reverse bevel color single line
Border
with a title
-
doubleLine
public static Border doubleLine()
Creates aBorder
that is drawn as a solid color double line surrounding the wrapped component- Returns:
- New solid color double line
Border
-
doubleLine
public static Border doubleLine(java.lang.String title)
Creates aBorder
that is drawn as a solid color double line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New solid color double line
Border
with a title
-
doubleLineBevel
public static Border doubleLineBevel()
Creates aBorder
that is drawn as a bevel color double line surrounding the wrapped component- Returns:
- New bevel color double line
Border
-
doubleLineBevel
public static Border doubleLineBevel(java.lang.String title)
Creates aBorder
that is drawn as a bevel color double line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New bevel color double line
Border
with a title
-
doubleLineReverseBevel
public static Border doubleLineReverseBevel()
Creates aBorder
that is drawn as a reverse bevel color double line surrounding the wrapped component- Returns:
- New reverse bevel color double line
Border
-
doubleLineReverseBevel
public static Border doubleLineReverseBevel(java.lang.String title)
Creates aBorder
that is drawn as a reverse bevel color double line surrounding the wrapped component with a title string normally drawn at the top-left side- Parameters:
title
- The title to draw on the border- Returns:
- New reverse bevel color double line
Border
with a title
-
joinLinesWithFrame
public static void joinLinesWithFrame(TextGraphics graphics)
This method will attempt to join line drawing characters with the outermost bottom and top rows and left and right columns. For example, if a vertical left border character is ║ and the character immediately to the right of it is ─, then the border character will be updated to ╟ to join the two together. Please note that this method will only join the outer border columns and rows.- Parameters:
graphics
- Graphics to use when inspecting and joining characters
-
-