Uses of Package
com.googlecode.lanterna.gui2

  • Class
    Description
    This is the main interface defining a component in Lanterna, although you will probably not implement this directly but rather extend the AbstractComponent or another one of the sub-classes instead to avoid implementing most of the methods in this interface.
    This interface defines a renderer for a component, an external class that does the sizing and rendering.
    Interface that defines a class that draws window decorations, i.e.
    Classes implementing this interface can be used along with DefaultWindowManagerTextGUI to put some extra processing after a window has been rendered.
  • Class
    Description
    This abstract implementation of BasePane has the common code shared by all different concrete implementations.
     
    Abstract implementation of Border interface that has some of the methods filled out.
    AbstractComponent provides some good default behaviour for a Component, all components in Lanterna extends from this class in some way.
    This abstract implementation contains common code for the different Composite implementations.
    Default implementation of Interactable that extends from AbstractComponent.
    Base class for several list box implementations, this will handle things like list of items and the scrollbar.
    The default list item renderer class, this can be extended and customized it needed.
    This abstract implementation of TextGUI contains some basic management of the underlying Screen and other common code that can be shared between different implementations.
    Abstract implementation of TextGUIThread with common logic for both available concrete implementations.
    Abstract Window has most of the code requiring for a window to function, all concrete window implementations extends from this in one way or another.
    This class is a list box implementation that displays a number of items that has actions associated with them.
    This is a special label that contains not just a single text to display but a number of frames that are cycled through.
    Extended interface of TextGUIThread for implementations that uses a separate thread for all GUI event processing and updating.
    Enum representing the states of the GUI thread life-cycle
    BasePane is the base container in a Text GUI.
    Base listener interface having callback methods for events relating to BasePane (and Window, which extends BasePane) so that you can be notified by a callback when certain events happen.
    Simple AbstractWindow implementation that you can use as a building block when creating new windows without having to create new classes.
    Main interface for different border classes, with additional methods to help lanterna figure out the size and offset of components wrapped by borders.
     
    This type is what you use as the layout data for components added to a panel using BorderLayout for its layout manager.
     
     
     
    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.
    Helper interface that doesn't add any new methods but makes coding new button renderers a little bit more clear
    Listener interface that can be used to catch user events on the button
    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.
    Helper interface that doesn't add any new methods but makes coding new check box renderers a little bit more clear
    Listener interface that can be used to catch user events on the check box
    This is a list box implementation where each item has its own checked state that can be toggled on and off
    Listener interface that can be attached to the CheckBoxList in order to be notified on user actions
    This is a simple combo box implementation that allows the user to select one out of multiple items through a drop-down menu.
    Helper interface that doesn't add any new methods but makes coding new combo box renderers a little bit more clear
    Listener interface that can be used to catch user events on the combo box
     
    This is the main interface defining a component in Lanterna, although you will probably not implement this directly but rather extend the AbstractComponent or another one of the sub-classes instead to avoid implementing most of the methods in this interface.
    This interface defines a renderer for a component, an external class that does the sizing and rendering.
    A Composite is a Container that contains only one (or zero) component.
    Container is a component that contains a collection of child components.
    Created by Martin on 2017-08-11.
    Enum for distinguishing between horizontal and vertical directions.
    Simple component which draws a solid color over its area.
    This emulates the behaviour of the GridLayout in SWT (as opposed to the one in AWT/Swing).
    The enum is used to specify where in a grid cell a component should be placed, in the case that the preferred size of the component is smaller than the space in the cell.
     
     
    This interface can be used to programmatically intercept input from the user and decide if the input should be passed on to the interactable.
    This interface marks a component as able to receive keyboard input from the user.
    When focus has changed, which direction.
    Enum to represent the various results coming out of the handleKeyStroke method
    This class is used to keep a 'map' of the usable area and note where all the interact:ables are.
    Extended interface for component renderers used with interactable components.
    Label is a simple read-only text display component.
    Empty interface to use for values that can be used as a layout meta-data on components.
    A layout manager is a class that takes an area of usable space and a list of components to fit on that space.
    Simple layout manager the puts all components on a single line, either horizontally or vertically.
    This enum type will decide the alignment of a component on the counter-axis, meaning the horizontal alignment on vertical LinearLayouts and vertical alignment on horizontal LinearLayouts.
    This enum type will what to do with a component if the container has extra space to offer.
    Set of predefined localized string.
    All this strings are localized by using LocalizedUIBundle.
    Changing the locale by calling Locale.setDefault(Locale).
    This is the main Text GUI implementation built into Lanterna, supporting multiple tiled windows and a dynamic background area that can be fully customized.
    This class is the basic building block for creating user interfaces, being the standard implementation of Container that supports multiple children.
    This GUI element gives a visual indication of how far a process of some sort has progressed at any given time.
    The list box will display a number of items, of which one and only one can be marked as selected.
    Listener interface that can be attached to the RadioBoxList in order to be notified on user actions
    Classic scrollbar that can be used to display where inside a larger component a view is showing.
    Helper class for making new ScrollBar renderers a little bit cleaner
    Static non-interactive component that is typically rendered as a single line.
    This is the default separator renderer that is used if you don't override anything.
    Helper interface that doesn't add any new methods but makes coding new button renderers a little bit more clear
     
    This component keeps a text content that is editable by the user.
    Enum value to force a TextBox to be either single line or multi line.
    Helper interface that doesn't add any new methods but makes coding new text box renderers a little bit more clear
    Listener interface for when the TextBox content has changed.
    This is the base interface for advanced text GUIs supported in Lanterna.
    Listener interface for TextGUI, firing on events related to the overall GUI
    This interface is the base part in the Lanterna Text GUI component hierarchy
    TextGraphics implementation used by TextGUI when doing any drawing operation.
    Class that represents the thread this is expected to run the event/input/update loop for the TextGUI.
    This interface defines an exception handler, that is used for looking at exceptions that occurs during the main event loop of the TextGUIThread.
    Factory class for creating TextGUIThread objects.
    Window is a base unit in the TextGUI system, it represents a collection of components grouped together, usually surrounded by a border and a title.
    Window hints are meta-data stored along with the window that can be used to give the GUI system some ideas of how this window wants to be treated.
    Extension of the TextGUI interface, this is intended as the base interface for any TextGUI that intends to make use of the Window class.
    Interface that defines a class that draws window decorations, i.e.
     
    Extended BasePaneListener for Window that exposes additional events that are specific to windows
    Window manager is a class that is plugged in to a WindowBasedTextGUI to manage the position and placement of windows.
    Classes implementing this interface can be used along with DefaultWindowManagerTextGUI to put some extra processing after a window has been rendered.
  • Class
    Description
    This abstract implementation of BasePane has the common code shared by all different concrete implementations.
    AbstractComponent provides some good default behaviour for a Component, all components in Lanterna extends from this class in some way.
    Abstract Window has most of the code requiring for a window to function, all concrete window implementations extends from this in one way or another.
    This class is a list box implementation that displays a number of items that has actions associated with them.
    BasePane is the base container in a Text GUI.
    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.
    This is the main interface defining a component in Lanterna, although you will probably not implement this directly but rather extend the AbstractComponent or another one of the sub-classes instead to avoid implementing most of the methods in this interface.
    A Composite is a Container that contains only one (or zero) component.
    Label is a simple read-only text display component.
    Set of predefined localized string.
    All this strings are localized by using LocalizedUIBundle.
    Changing the locale by calling Locale.setDefault(Locale).
    This component keeps a text content that is editable by the user.
    This interface is the base part in the Lanterna Text GUI component hierarchy
    Window is a base unit in the TextGUI system, it represents a collection of components grouped together, usually surrounded by a border and a title.
    Window hints are meta-data stored along with the window that can be used to give the GUI system some ideas of how this window wants to be treated.
    Extension of the TextGUI interface, this is intended as the base interface for any TextGUI that intends to make use of the Window class.
  • Class
    Description
    AbstractComponent provides some good default behaviour for a Component, all components in Lanterna extends from this class in some way.
    Default implementation of Interactable that extends from AbstractComponent.
    This is the main interface defining a component in Lanterna, although you will probably not implement this directly but rather extend the AbstractComponent or another one of the sub-classes instead to avoid implementing most of the methods in this interface.
    This interface defines a renderer for a component, an external class that does the sizing and rendering.
    Container is a component that contains a collection of child components.
    This interface marks a component as able to receive keyboard input from the user.
    Enum to represent the various results coming out of the handleKeyStroke method
    This class is used to keep a 'map' of the usable area and note where all the interact:ables are.
    Extended interface for component renderers used with interactable components.
    This interface is the base part in the Lanterna Text GUI component hierarchy
    TextGraphics implementation used by TextGUI when doing any drawing operation.
  • Class
    Description
    AbstractComponent provides some good default behaviour for a Component, all components in Lanterna extends from this class in some way.
    Default implementation of Interactable that extends from AbstractComponent.
    This is the main interface defining a component in Lanterna, although you will probably not implement this directly but rather extend the AbstractComponent or another one of the sub-classes instead to avoid implementing most of the methods in this interface.
    This interface defines a renderer for a component, an external class that does the sizing and rendering.
    This interface marks a component as able to receive keyboard input from the user.
    Enum to represent the various results coming out of the handleKeyStroke method
    Extended interface for component renderers used with interactable components.
    Classic scrollbar that can be used to display where inside a larger component a view is showing.
    This interface is the base part in the Lanterna Text GUI component hierarchy
    TextGraphics implementation used by TextGUI when doing any drawing operation.