Package | Description |
---|---|
com.googlecode.lanterna.graphics | |
com.googlecode.lanterna.gui2 | |
com.googlecode.lanterna.gui2.table |
Modifier and Type | Interface | Description |
---|---|---|
static interface |
SimpleTheme.RendererProvider<T extends Component> |
Modifier and Type | Method | Description |
---|---|---|
<T extends Component> |
DelegatingThemeDefinition.getRenderer(Class<T> type) |
|
<T extends Component> |
SimpleTheme.Definition.getRenderer(Class<T> type) |
|
<T extends Component> |
ThemeDefinition.getRenderer(Class<T> type) |
Returns a
ComponentRenderer attached to this definition for the specified type. |
<T extends Component> |
SimpleTheme.Definition.setRenderer(Class<T> type,
SimpleTheme.RendererProvider<T> rendererProvider) |
Registered a callback to get a custom
ComponentRenderer for a particular class. |
Modifier and Type | Class | Description |
---|---|---|
class |
AbstractComponent<T extends Component> |
AbstractComponent provides some good default behaviour for a
Component , all components in Lanterna extends
from this class in some way. |
interface |
ComponentRenderer<T extends Component> |
This interface defines a renderer for a component, an external class that does the sizing and rendering.
|
interface |
InteractableRenderer<T extends Component & Interactable> |
Extended interface for component renderers used with interactable components.
|
Modifier and Type | Interface | Description |
---|---|---|
interface |
Border |
Main interface for different border classes, with additional methods to help lanterna figure out the size and offset
of components wrapped by borders.
|
interface |
Container |
Container is a component that contains a collection of child components.
|
interface |
Interactable |
This interface marks a component as able to receive keyboard input from the user.
|
Modifier and Type | Class | Description |
---|---|---|
protected class |
AbstractBasePane.ContentHolder |
|
class |
AbstractBorder |
Abstract implementation of
Border interface that has some of the methods filled out. |
class |
AbstractComponent<T extends Component> |
AbstractComponent provides some good default behaviour for a
Component , all components in Lanterna extends
from this class in some way. |
class |
AbstractComposite<T extends Container> |
This abstract implementation contains common code for the different
Composite implementations. |
class |
AbstractInteractableComponent<T extends AbstractInteractableComponent<T>> |
Default implementation of Interactable that extends from AbstractComponent.
|
class |
AbstractListBox<V,T extends AbstractListBox<V,T>> |
Base class for several list box implementations, this will handle things like list of items and the scrollbar.
|
class |
ActionListBox |
This class is a list box implementation that displays a number of items that has actions associated with them.
|
class |
AnimatedLabel |
This is a special label that contains not just a single text to display but a number of frames that are cycled
through.
|
class |
Button |
Simple labeled button that the user can trigger by pressing the Enter or the Spacebar key on the keyboard when the
component is in focus.
|
class |
CheckBox |
The checkbox component looks like a regular checkbox that you can find in modern graphics user interfaces, a label
and a space that the user can toggle on and off by using enter or space keys.
|
class |
CheckBoxList<V> |
This is a list box implementation where each item has its own checked state that can be toggled on and off
|
class |
ComboBox<V> |
This is a simple combo box implementation that allows the user to select one out of multiple items through a
drop-down menu.
|
class |
EmptySpace |
Simple component which draws a solid color over its area.
|
class |
GUIBackdrop |
Special component that is by default displayed as the background of a text gui unless you override it with something
else.
|
class |
Label |
Label is a simple read-only text display component.
|
class |
Panel |
This class is the basic building block for creating user interfaces, being the standard implementation of
Container that supports multiple children. |
class |
ProgressBar |
This GUI element gives a visual indication of how far a process of some sort has progressed at any given time.
|
class |
RadioBoxList<V> |
The list box will display a number of items, of which one and only one can be marked as selected.
|
class |
ScrollBar |
Classic scrollbar that can be used to display where inside a larger component a view is showing.
|
class |
Separator |
Static non-interactive component that is typically rendered as a single line.
|
class |
TextBox |
This component keeps a text content that is editable by the user.
|
Modifier and Type | Method | Description |
---|---|---|
Component |
Component.addTo(Panel panel) |
Same as calling
panel.addComponent(thisComponent) |
Component |
AbstractBasePane.getComponent() |
|
Component |
AbstractComposite.getComponent() |
|
Component |
BasePane.getComponent() |
Returns the component that is the content of the BasePane.
|
Component |
Composite.getComponent() |
Returns the component that this Composite is wrapping
|
Component |
Window.getComponent() |
Returns the component which is the top-level in the component hierarchy inside this window.
|
Component |
Component.setLayoutData(LayoutData data) |
Sets optional layout data associated with this component.
|
Component |
Component.setPosition(TerminalPosition position) |
This method will be called by the layout manager when it has decided where the component is to be located.
|
Component |
Component.setPreferredSize(TerminalSize explicitPreferredSize) |
Overrides the components preferred size calculation and makes the
getPreferredSize() always return the
value passed in here. |
Component |
Component.setSize(TerminalSize size) |
This method will be called by the layout manager when it has decided how large the component will be.
|
Component |
AbstractComponent.setTheme(Theme theme) |
|
Component |
Component.setTheme(Theme theme) |
Overrides the
Theme this component will use so rather than deriving the theme from either the window or
the GUI system, it will always return this theme. |
Modifier and Type | Method | Description |
---|---|---|
Collection<Component> |
AbstractComposite.getChildren() |
|
Collection<Component> |
Container.getChildren() |
Returns collection that is to be considered a copy of the list of children contained inside of this object.
|
Collection<Component> |
Panel.getChildren() |
|
List<Component> |
AbstractComposite.getChildrenList() |
|
List<Component> |
Container.getChildrenList() |
Returns list that is to be considered a copy of the list of children inside of this container.
|
List<Component> |
Panel.getChildrenList() |
|
ComponentRenderer<? extends Component> |
Component.getRenderer() |
Returns the renderer used to draw this component and measure its preferred size.
|
Modifier and Type | Method | Description |
---|---|---|
Panel |
Panel.addComponent(int index,
Component component) |
Adds a new child component to the panel.
|
Panel |
Panel.addComponent(Component component) |
Adds a new child component to the panel.
|
Panel |
Panel.addComponent(Component component,
LayoutData layoutData) |
This method is a shortcut for calling:
|
boolean |
AbstractComposite.containsComponent(Component component) |
|
boolean |
Container.containsComponent(Component component) |
Returns
true if this container contains the supplied component either directly or indirectly through
intermediate containers. |
boolean |
Panel.containsComponent(Component component) |
|
static Panel |
Panels.grid(int columns,
Component... components) |
Creates a new
Panel with a GridLayout layout manager and adds all the components passed in |
static Panel |
Panels.horizontal(Component... components) |
Creates a new
Panel with a LinearLayout layout manager in horizontal mode and adds all the
components passed in |
boolean |
AbstractBasePane.ContentHolder.removeComponent(Component component) |
|
boolean |
AbstractComposite.removeComponent(Component component) |
|
boolean |
Container.removeComponent(Component component) |
Removes the component from the container.
|
boolean |
Panel.removeComponent(Component component) |
|
void |
AbstractBasePane.ContentHolder.setComponent(Component component) |
|
void |
AbstractBasePane.setComponent(Component component) |
|
void |
AbstractBorder.setComponent(Component component) |
|
void |
AbstractComposite.setComponent(Component component) |
|
void |
BasePane.setComponent(Component component) |
Sets the top-level component inside this BasePane.
|
void |
Composite.setComponent(Component component) |
Sets the component which is inside this Composite.
|
void |
Window.setComponent(Component component) |
Sets the top-level component in the window, this will be the only component unless it's a container of some kind
that you add child-components to.
|
static Panel |
Panels.vertical(Component... components) |
Creates a new
Panel with a LinearLayout layout manager in vertical mode and adds all the
components passed in |
Modifier and Type | Method | Description |
---|---|---|
void |
AbsoluteLayout.doLayout(TerminalSize area,
List<Component> components) |
|
void |
BorderLayout.doLayout(TerminalSize area,
List<Component> components) |
|
void |
GridLayout.doLayout(TerminalSize area,
List<Component> components) |
|
void |
LayoutManager.doLayout(TerminalSize area,
List<Component> components) |
Given a size constraint, update the location and size of each component in the component list by laying them out
in the available area.
|
void |
LinearLayout.doLayout(TerminalSize area,
List<Component> components) |
|
TerminalSize |
AbsoluteLayout.getPreferredSize(List<Component> components) |
|
TerminalSize |
BorderLayout.getPreferredSize(List<Component> components) |
|
TerminalSize |
GridLayout.getPreferredSize(List<Component> components) |
|
TerminalSize |
LayoutManager.getPreferredSize(List<Component> components) |
This method returns the dimensions it would prefer to have to be able to layout all components while giving all
of them as much space as they are asking for.
|
TerminalSize |
LinearLayout.getPreferredSize(List<Component> components) |
Constructor | Description |
---|---|
MultiWindowTextGUI(TextGUIThreadFactory guiThreadFactory,
Screen screen,
WindowManager windowManager,
WindowPostRenderer postRenderer,
Component background) |
Creates a new
MultiWindowTextGUI that uses the specified Screen as the backend for all drawing
operations. |
MultiWindowTextGUI(Screen screen,
WindowManager windowManager,
Component background) |
Creates a new
MultiWindowTextGUI that uses the specified Screen as the backend for all drawing
operations. |
MultiWindowTextGUI(Screen screen,
WindowManager windowManager,
WindowPostRenderer postRenderer,
Component background) |
Creates a new
MultiWindowTextGUI that uses the specified Screen as the backend for all drawing
operations. |
Modifier and Type | Class | Description |
---|---|---|
class |
Table<V> |
The table class is an interactable component that displays a grid of cells containing data along with a header of
labels.
|
Copyright © 2020. All rights reserved.