Module cli

Package de.grogra.cli.ui

Class CLIConsolePanel

java.lang.Object

de.grogra.cli.ui.CLIPanelSupport

de.grogra.cli.ui.CLIConsolePanel

All Implemented Interfaces:

ExecutableComponent, RegistryContext, Console, Context, Panel, Synchronizer.Callback, Disposable

public class CLIConsolePanel
extends CLIPanelSupport
implements Console

Nested Class Summary

Nested classes/interfaces inherited from interface de.grogra.pf.ui.Console

Console.ConsoleWriter

Field Summary

Fields inherited from class de.grogra.cli.ui.CLIPanelSupport

mapProducer, menu, MIN_UNUSED_ACTION, panelId, sync, ws

Fields inherited from interface de.grogra.pf.ui.Console

USE_LAF_COLOR

Fields inherited from interface de.grogra.pf.ui.Panel

DEC_WAIT_CURSOR, DEFAULT_CURSOR, INC_WAIT_CURSOR, INHERIT_CURSOR, PANEL_ID, WAIT_CURSOR

Constructor Summary

Constructors

Constructor	Description
CLIConsolePanel(Context context, Map params)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the console.
protected void	disposeImpl()
void	enter(String text)	Enters text as if the user had typed this text.
ComponentWrapper	getContent()
de.grogra.cli.ui.CLIConsolePanel.ConsoleWriterCLI	getErr()	This method returns a ConsoleWriter which is used to write to the console.
Reader	getIn()	This method returns a Reader which can be used to obtain the textual input from the user.
de.grogra.cli.ui.CLIConsolePanel.ConsoleWriterCLI	getOut()	This method returns a ConsoleWriter which is used to write to the console.
void	setContent(ComponentWrapper content)
void	setNameCompletion(NameCompletion nc)

Methods inherited from class de.grogra.cli.ui.CLIPanelSupport

checkClose, checkClose, configure, dispose, executeCheckClose, getComponent, getDecorator, getMenu, getPanel, getPanelId, getRegistry, getUIPropertyMap, getWindow, getWorkbench, hide, initDecorator, initialize, resolve, run, run, setCursor, setMenu, show, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.grogra.pf.ui.Context

getComponent, getPanel, getWindow, getWorkbench

Methods inherited from interface de.grogra.util.Disposable

dispose

Methods inherited from interface de.grogra.pf.ui.Panel

checkClose, getDecorator, getMenu, getPanelId, getUIPropertyMap, initDecorator, initialize, resolve, setCursor, setMenu, show

Constructor Details

CLIConsolePanel

public CLIConsolePanel(Context context,
 Map params)

Method Details

getContent

public ComponentWrapper getContent()

Specified by:

getContent in interface Panel

Overrides:

getContent in class CLIPanelSupport

setContent

public void setContent(ComponentWrapper content)

Specified by:

setContent in interface Panel

Overrides:

setContent in class CLIPanelSupport

disposeImpl

protected void disposeImpl()

Overrides:

disposeImpl in class CLIPanelSupport

enter

public void enter(String text)

Description copied from interface: Console

Enters text as if the user had typed this text.

Specified by:

enter in interface Console

Parameters:

text - text to enter in the console

clear

public void clear()

Description copied from interface: Console

Clears the console.

Specified by:

clear in interface Console

getIn

public Reader getIn()

Description copied from interface: Console

This method returns a Reader which can be used to obtain the textual input from the user.

Specified by:

getIn in interface Console

Returns:

a reader

getOut

public de.grogra.cli.ui.CLIConsolePanel.ConsoleWriterCLI getOut()

Description copied from interface: Console

This method returns a ConsoleWriter which is used to write to the console. It should be used for normal messages.

Specified by:

getOut in interface Console

Returns:

a writer

getErr

public de.grogra.cli.ui.CLIConsolePanel.ConsoleWriterCLI getErr()

Description copied from interface: Console

This method returns a ConsoleWriter which is used to write to the console. It should be used for error messages. Implementations should use a different color to highlight the characters which are written through this writer.

Specified by:

getErr in interface Console

Returns:

a writer

setNameCompletion

public void setNameCompletion(NameCompletion nc)

Specified by:

setNameCompletion in interface Console