view.guicomponents.guiconsole

Class ConsolePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

view.guicomponents.guiconsole.ConsolePanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener

public class ConsolePanel
extends javax.swing.JPanel
implements java.awt.event.KeyListener, javax.swing.event.DocumentListener, java.awt.event.ActionListener

A panel consisting of GUI console input and output.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONSOLE_FONT_NAME
static java.awt.Font	CONSOLE_INPUT_FONT

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ConsolePanel(MainControl mainControl, ArgumentComponentManager argumentComponentManager) Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ev)
void	addToHistory(java.lang.String input, boolean forceInsertion) Adds the given input to the input history.
void	appendOutput(java.lang.String message) Appends the given string to the GUI console output.
void	changedUpdate(javax.swing.event.DocumentEvent ev)
void	enterInput(java.lang.String input, boolean print, boolean execute) Treads the given input as if it was created by the user.
void	enterTextFieldInput() Executes the statement of the text field.
ExecutionReturn	executeAndPrint(java.lang.String input) Executes the given statement and prints the statement as well as, if existing, the execution result to the GUI console output.
ConsoleInputField	getConsoleInputField() Returns the inner console input text field.
ConsoleUserInput	getEnteredInput() Returns the instance holding the last user input.
InputHistory	getInputHistory() Returns the input history.
java.lang.Object	getQuitNotification() Returns the object that is notified when a Quit is the result of an execution.
void	insertUpdate(javax.swing.event.DocumentEvent ev)
void	keyPressed(java.awt.event.KeyEvent ev)
void	keyReleased(java.awt.event.KeyEvent ev)
void	keyTyped(java.awt.event.KeyEvent ev)
void	removeUpdate(javax.swing.event.DocumentEvent ev)
void	saveHistory() Saves the input history to the file which was previously set using setInputHistoryFile.
void	setFocus() Sets the focus to the input text field.
void	setInputHistoryFile(java.io.File file) Sets the given file to load and save the input history.
void	setInputText(java.lang.String line) Sets the text of the console input field.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

CONSOLE_FONT_NAME

public static final java.lang.String CONSOLE_FONT_NAME

See Also:

Constant Field Values

CONSOLE_INPUT_FONT

public static final java.awt.Font CONSOLE_INPUT_FONT

Constructor Detail

ConsolePanel

public ConsolePanel(MainControl mainControl,
                    ArgumentComponentManager argumentComponentManager)

Creates an instance.

Parameters:

mainControl - the main control of Graphana

argumentComponentManager - the argument component manager to create argument components

Method Detail

executeAndPrint

public ExecutionReturn executeAndPrint(java.lang.String input)

Executes the given statement and prints the statement as well as, if existing, the execution result to the GUI console output. Notifies, if the result is a Quit command.

Parameters:

input - the input to execute

Returns:

the result of the execution

addToHistory

public void addToHistory(java.lang.String input,
                         boolean forceInsertion)

Adds the given input to the input history.

Parameters:

input - the input to insert

forceInsertion - if true, then the input will always be inserted. If false, then its only inserted if it is not present in the history yet.

enterInput

public void enterInput(java.lang.String input,
                       boolean print,
                       boolean execute)

Treads the given input as if it was created by the user.

Parameters:

input - the input to simulate

print - if true, the input will be printed in the GUI console output and added to the input history.

execute - if true, the input will be executed.

enterTextFieldInput

public void enterTextFieldInput()

Executes the statement of the text field. The input as well as, if existent, the result of the execution, is printed in the console output. The text field is cleared.

appendOutput

public void appendOutput(java.lang.String message)

Appends the given string to the GUI console output.

setInputHistoryFile

public void setInputHistoryFile(java.io.File file)

Sets the given file to load and save the input history.

saveHistory

public void saveHistory()
                 throws java.io.IOException

Saves the input history to the file which was previously set using setInputHistoryFile. Only a limited number of inputs is saved.

Throws:

java.io.IOException

getInputHistory

public InputHistory getInputHistory()

Returns the input history.

setFocus

public void setFocus()

Sets the focus to the input text field.

getQuitNotification

public java.lang.Object getQuitNotification()

Returns the object that is notified when a Quit is the result of an execution.

getEnteredInput

public ConsoleUserInput getEnteredInput()

Returns the instance holding the last user input.

setInputText

public void setInputText(java.lang.String line)

Sets the text of the console input field.

getConsoleInputField

public ConsoleInputField getConsoleInputField()

Returns the inner console input text field.

keyPressed

public void keyPressed(java.awt.event.KeyEvent ev)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent ev)

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent ev)

Specified by:

keyTyped in interface java.awt.event.KeyListener

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent ev)

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent ev)

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent ev)

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ev)

Specified by:

actionPerformed in interface java.awt.event.ActionListener