Module com.googlecode.lanterna

Package com.googlecode.lanterna.gui2

Class ImageComponent

java.lang.Object

com.googlecode.lanterna.gui2.AbstractComponent<T>

com.googlecode.lanterna.gui2.AbstractInteractableComponent

com.googlecode.lanterna.gui2.ImageComponent

All Implemented Interfaces:

Component, Interactable, TextGUIElement

public class ImageComponent
extends AbstractInteractableComponent

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui2.Interactable

Interactable.FocusChangeDirection, Interactable.Result

Field Summary

Fields

Modifier and Type	Field	Description
private TextImage	textImage

Constructor Summary

Constructors

Constructor	Description
ImageComponent()

Method Summary

Modifier and Type	Method	Description
InteractableRenderer<ImageComponent>	createDefaultRenderer()	When you create a custom component, you need to implement this method and return a Renderer which is responsible for taking care of sizing the component, rendering it and choosing where to place the cursor (if Interactable).
Interactable.Result	handleKeyStroke(KeyStroke keyStroke)	This method can be overridden to handle various user input (mostly from the keyboard) when this component is in focus.
void	setTextImage(TextImage textImage)

Methods inherited from class com.googlecode.lanterna.gui2.AbstractInteractableComponent

afterEnterFocus, afterLeaveFocus, getCursorLocation, getInputFilter, getRenderer, handleInput, isActivationStroke, isEnabled, isFocusable, isFocused, isKeyboardActivationStroke, isMouseActivationStroke, isMouseDown, isMouseDrag, isMouseMove, isMouseUp, onEnterFocus, onLeaveFocus, setEnabled, setInputFilter, takeFocus

Methods inherited from class com.googlecode.lanterna.gui2.AbstractComponent

addTo, calculatePreferredSize, draw, getBasePane, getGlobalPosition, getLayoutData, getParent, getPosition, getPreferredSize, getSize, getTextGUI, getTheme, getThemeDefinition, hasParent, invalidate, isInside, isInvalid, isVisible, onAdded, onAfterDrawing, onBeforeDrawing, onRemoved, runOnGUIThreadIfExistsOtherwiseRunDirect, self, setLayoutData, setPosition, setPreferredSize, setRenderer, setSize, setTheme, setVisible, toBasePane, toGlobal, withBorder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.googlecode.lanterna.gui2.Component

addTo, getBasePane, getGlobalPosition, getLayoutData, getParent, getPosition, getPreferredSize, getSize, getTextGUI, getTheme, getThemeDefinition, hasParent, invalidate, isInside, isVisible, onAdded, onRemoved, setLayoutData, setPosition, setPreferredSize, setSize, setTheme, setVisible, toBasePane, toGlobal, withBorder

Methods inherited from interface com.googlecode.lanterna.gui2.TextGUIElement

draw, isInvalid

Field Detail

textImage

private TextImage textImage

Constructor Detail

ImageComponent

public ImageComponent()

Method Detail

setTextImage

public void setTextImage(TextImage textImage)

createDefaultRenderer

public InteractableRenderer<ImageComponent> createDefaultRenderer()

Description copied from class: AbstractComponent

When you create a custom component, you need to implement this method and return a Renderer which is responsible for taking care of sizing the component, rendering it and choosing where to place the cursor (if Interactable). This value is intended to be overridden by custom themes.

Specified by:

createDefaultRenderer in class AbstractInteractableComponent

Returns:

Renderer to use when sizing and drawing this component

handleKeyStroke

public Interactable.Result handleKeyStroke(KeyStroke keyStroke)

Description copied from class: AbstractInteractableComponent

This method can be overridden to handle various user input (mostly from the keyboard) when this component is in focus. The input method from the interface, handleInput(..) is final in AbstractInteractableComponent to ensure the input filter is properly handled. If the filter decides that this event should be processed, it will call this method.

Overrides:

handleKeyStroke in class AbstractInteractableComponent

Parameters:

keyStroke - What input was entered by the user

Returns:

Result of processing the key-stroke