Console (Console API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - console.Console

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, org.gjt.sp.jedit.EBComponent, org.gjt.sp.jedit.gui.DefaultFocusComponent
```
public class Console
extends javax.swing.JPanel
implements org.gjt.sp.jedit.EBComponent, org.gjt.sp.jedit.gui.DefaultFocusComponent
```
Console - an instance of a panel inside a dockablewindow. May contain multiple Shells, each with its own shell state.

Version:

$Id: Console.java 22989 2013-05-16 00:26:20Z ezust $

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Console.EvalAction`
`class`	`Console.ShellState` Each Shell of a Console has its own ShellState A ShellState is a writable Output.

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 inherited from class javax.swing.JComponent
  accessibleContext, 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
  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

Console(org.gjt.sp.jedit.View view)

Constructors
Constructor and Description
`Console(org.gjt.sp.jedit.View view)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`chDir(java.lang.String path)`
`boolean`	`chDir(java.lang.String path, boolean selectShell)` Changes the directory of the current Console.
`void`	`clear()`
`void`	`commandDone()` Deprecated. Do not use the console as an `Output` instance, use the `Output` given to you in `Shell.execute()` instead.
`void`	`focusOnDefaultComponent()`
`ConsolePane`	`getConsolePane()`
`java.awt.Color`	`getErrorColor()` Returns the error text color.
`errorlist.DefaultErrorSource`	`getErrorSource()` Returns this console's error source instance.
`int`	`getId()`
`java.awt.Color`	`getInfoColor()` Returns the informational text color.
`Output`	`getOutput()` Returns the output instance for the currently selected Shell.
`Output`	`getOutput(java.lang.String shellName)` Returns the Output corresponding to a particular Shell, without changing the selected Shell.
`javax.swing.JTextPane`	`getOutputPane()` Deprecated. Use getConsolePane() instead.
`java.awt.Color`	`getPlainColor()`
`Shell`	`getShell()`
`Console.ShellState`	`getShellState(Shell shell)`
`org.gjt.sp.jedit.View`	`getView()`
`java.awt.Color`	`getWarningColor()` Returns the warning text color.
`void`	`handleMessage(org.gjt.sp.jedit.EBMessage msg)`
`void`	`handleNodeSelected(org.gjt.sp.jedit.msg.VFSPathSelected msg)`
`void`	`handlePluginUpdate(org.gjt.sp.jedit.msg.PluginUpdate pmsg)`
`void`	`load()`
`void`	`print(java.awt.Color color, java.lang.String msg)` Deprecated. Do not use the console as an `Output` instance, use the `Output` given to you in `Shell.execute()` instead.
`void`	`run(Shell shell, Output output, java.lang.String command)` Convenience function currently used by some beanshell macros.
`void`	`run(Shell shell, java.lang.String command)`
`void`	`run(Shell shell, java.lang.String input, Output output, Output error, java.lang.String cmd)` Runs the specified command.
`void`	`runLastCommand()` Meant to be used as a user action.
`void`	`scrollToBottom()`
`Shell`	`setShell(Shell shell)` Creates a ShellState (output instance) if necessary.
`Shell`	`setShell(java.lang.String shellStr)`
`static java.lang.String`	`shellForVFS(java.lang.String path)`
`void`	`startAnimation()`
`void`	`stopAnimation()`
`void`	`unload()`
`void`	`updateAnimation()`
`void`	`writeAttrs(javax.swing.text.AttributeSet attrs, java.lang.String msg)` Deprecated. Do not use the console as an `Output` instance, use the `Output` given to you in `Shell.execute()` instead. see @ref Output for information about how to create additional console Output instances.

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, 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, hide, 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

- Constructor Detail
  - Console
```
public Console(org.gjt.sp.jedit.View view)
```
- Method Detail
  - focusOnDefaultComponent
```
public void focusOnDefaultComponent()
```
    Specified by:
    
    focusOnDefaultComponent in interface org.gjt.sp.jedit.gui.DefaultFocusComponent
  - load
```
public void load()
```
  - unload
```
public void unload()
```
  - getView
```
public org.gjt.sp.jedit.View getView()
```
  - getShell
```
public Shell getShell()
```
  - setShell
```
public Shell setShell(java.lang.String shellStr)
```
  - setShell
```
public Shell setShell(Shell shell)
```
    Creates a ShellState (output instance) if necessary. Sets the current active shell to be this new shell.
  - scrollToBottom
```
public void scrollToBottom()
```
  - getConsolePane
```
public ConsolePane getConsolePane()
```
  - getOutputPane
```
public javax.swing.JTextPane getOutputPane()
```
    Deprecated. Use getConsolePane() instead.
  - clear
```
public void clear()
```
  - getOutput
```
public Output getOutput(java.lang.String shellName)
```
    Returns the Output corresponding to a particular Shell, without changing the selected Shell.
  - getOutput
```
public Output getOutput()
```
    Returns the output instance for the currently selected Shell.
    
    Since:
    
    Console 3.6
  - runLastCommand
```
public void runLastCommand()
```
    Meant to be used as a user action.
  - handleMessage
```
public void handleMessage(org.gjt.sp.jedit.EBMessage msg)
```
    Specified by:
    
    handleMessage in interface org.gjt.sp.jedit.EBComponent
  - getErrorSource
```
public errorlist.DefaultErrorSource getErrorSource()
```
    Returns this console's error source instance. Plugin shells can either add errors to this error source, or use their own; both methods will look the same to the user.
  - getInfoColor
```
public java.awt.Color getInfoColor()
```
    Returns the informational text color.
  - getWarningColor
```
public java.awt.Color getWarningColor()
```
    Returns the warning text color.
  - getErrorColor
```
public java.awt.Color getErrorColor()
```
    Returns the error text color.
  - getPlainColor
```
public java.awt.Color getPlainColor()
```
  - getId
```
public int getId()
```
    Returns:
    a unique identifier starting at 0, representing which instance of Console this is, or -1 if that value can not be determined.
  - print
```
public void print(java.awt.Color color,
         java.lang.String msg)
```
    Deprecated. Do not use the console as an Output instance, use the Output given to you in Shell.execute() instead.
  - writeAttrs
```
public void writeAttrs(javax.swing.text.AttributeSet attrs,
              java.lang.String msg)
```
    Deprecated. Do not use the console as an Output instance, use the Output given to you in Shell.execute() instead. see @ref Output for information about how to create additional console Output instances.
  - commandDone
```
public void commandDone()
```
    Deprecated. Do not use the console as an Output instance, use the Output given to you in Shell.execute() instead.
  - getShellState
```
public Console.ShellState getShellState(Shell shell)
```
    Returns:
    the Output of a Shell, assuming the Shell was already created....
    Since:
    
    Console 4.0.2.
  - stopAnimation
```
public void stopAnimation()
```
  - startAnimation
```
public void startAnimation()
```
  - run
```
public void run(Shell shell,
       java.lang.String input,
       Output output,
       Output error,
       java.lang.String cmd)
```
    Runs the specified command. Note that with most shells, this method returns immediately, and execution of the command continues in a different thread. If you want to wait for command completion, call the waitFor() method of the shell instance.
    
    Parameters:
    shell - The shell instance. Obtain one either with Console.getShell() or Shell.getShell().
    input - The input to send to the command
    output - The output stream. Either the return value of getOutput(), or a new instance of BufferOutput.
    error - The error stream. Either the return value of getOutput(), or a new instance of BufferOutput.
    cmd - The command
  - run
```
public void run(Shell shell,
       java.lang.String command)
```
  - run
```
public void run(Shell shell,
       Output output,
       java.lang.String command)
```
    Convenience function currently used by some beanshell macros.
    
    Parameters:
    shell - the shell to execute it in
    output - something to write to
    command - the thing to execute
  - chDir
```
public boolean chDir(java.lang.String path,
            boolean selectShell)
```
    Changes the directory of the current Console.
    
    Parameters:
    path - to change to.
    selectShell - if true, will first select a Shell that returns true from handlesVFS(path)
    
    Returns:
    true if it did something.
  - chDir
```
public boolean chDir(java.lang.String path)
```
  - shellForVFS
```
public static java.lang.String shellForVFS(java.lang.String path)
```
    Returns:
    a shell that is suited for this path, based on passing this path onto the handlesVFS() method of each Shell.
  - handleNodeSelected
```
public void handleNodeSelected(org.gjt.sp.jedit.msg.VFSPathSelected msg)
```
  - handlePluginUpdate
```
public void handlePluginUpdate(org.gjt.sp.jedit.msg.PluginUpdate pmsg)
```
  - updateAnimation
```
public void updateAnimation()
```

Class Console

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

Console

Method Detail

focusOnDefaultComponent

load

unload

getView

getShell

setShell

setShell

scrollToBottom

getConsolePane

getOutputPane

clear

getOutput

getOutput

runLastCommand

handleMessage

getErrorSource

getInfoColor

getWarningColor

getErrorColor

getPlainColor

getId

print

writeAttrs

commandDone

getShellState

stopAnimation

startAnimation

run

run

run

chDir

chDir

shellForVFS

handleNodeSelected

handlePluginUpdate

updateAnimation