SshToolsApplicationSessionPanel (J2SSH Javadocs)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.sshtools.common.ui.SshToolsApplicationPanel
        
        com.sshtools.common.ui.SshToolsApplicationSessionPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
```
public abstract class SshToolsApplicationSessionPanel
extends SshToolsApplicationPanel
```
Version:

$Revision: 1.12 $

Author:

$author$

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.sshtools.common.ui.SshToolsApplicationPanel
  SshToolsApplicationPanel.ActionMenu
- 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
`protected SshToolsConnectionProfile`	`currentConnectionProfile`
`protected org.apache.commons.logging.Log`	`log`
`protected SessionManager`	`manager`
`static java.lang.String`	`PREF_CONNECTION_FILE_DIRECTORY`

Fields inherited from class com.sshtools.common.ui.SshToolsApplicationPanel
actionMenus, actions, actionsVisible, application, container, contextMenu, menuBar, toolBar, toolsVisible

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
`SshToolsApplicationSessionPanel()` Creates a new SshToolsApplicationClientPanel object.
`SshToolsApplicationSessionPanel(java.awt.LayoutManager mgr)` Creates a new SshToolsApplicationClientPanel object.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addEventListener(ChannelEventListener eventListener)`
`boolean`	`editSettings(SshToolsConnectionProfile profile)`
`abstract SshToolsConnectionTab[]`	`getAdditionalConnectionTabs()`
`SshToolsConnectionProfile`	`getCurrentConnectionProfile()`
`abstract java.lang.String`	`getId()`
`boolean`	`isConnected()` Returns the connected state of the panel
`abstract boolean`	`onOpenSession()`
`boolean`	`openSession(SessionManager manager, SshToolsConnectionProfile profile)`
`abstract boolean`	`requiresConfiguration()`
`void`	`setContainerTitle(java.io.File file)` Set the title of the container
`void`	`setCurrentConnectionProfile(SshToolsConnectionProfile profile)`

Methods inherited from class com.sshtools.common.ui.SshToolsApplicationPanel
addFavorite, canClose, close, deregisterAction, getAction, getActionMenu, getApplication, getContainer, getContextMenu, getIcon, getJMenuBar, getStatusBar, getToolBar, init, isToolsVisible, rebuildActionComponents, registerAction, registerActionMenu, setActionVisible, setAvailableActions, setContainer, setMenuBarVisible, setStatusBarVisible, setToolBarVisible, setToolsVisible, showErrorMessage, showErrorMessage, showExceptionMessage, showOptions

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

PREF_CONNECTION_FILE_DIRECTORY

public static final java.lang.String PREF_CONNECTION_FILE_DIRECTORY

See Also:: Constant Field Values

log

protected org.apache.commons.logging.Log log

currentConnectionProfile

protected SshToolsConnectionProfile currentConnectionProfile

manager
```
protected SessionManager manager
```

Constructor Detail
- SshToolsApplicationSessionPanel
```
public SshToolsApplicationSessionPanel()
```
  Creates a new SshToolsApplicationClientPanel object.
- SshToolsApplicationSessionPanel
```
public SshToolsApplicationSessionPanel(java.awt.LayoutManager mgr)
```
  Creates a new SshToolsApplicationClientPanel object.
  
  Parameters:
  
  mgr -

Method Detail

getAdditionalConnectionTabs

public abstract SshToolsConnectionTab[] getAdditionalConnectionTabs()

Returns:

addEventListener

public abstract void addEventListener(ChannelEventListener eventListener)

requiresConfiguration

public abstract boolean requiresConfiguration()

getId

public abstract java.lang.String getId()

openSession

public final boolean openSession(SessionManager manager,
                                 SshToolsConnectionProfile profile)
                          throws java.io.IOException

Parameters:: manager -; profile -
Throws:: java.io.IOException

onOpenSession

public abstract boolean onOpenSession()
                               throws java.io.IOException

Throws:: java.io.IOException

isConnected
```
public boolean isConnected()
```
Description copied from class: SshToolsApplicationPanel

Returns the connected state of the panel

Specified by:

isConnected in class SshToolsApplicationPanel

Returns:

setContainerTitle
```
public void setContainerTitle(java.io.File file)
```
Description copied from class: SshToolsApplicationPanel

Set the title of the container

Overrides:

setContainerTitle in class SshToolsApplicationPanel

Parameters:

file -

setCurrentConnectionProfile

public void setCurrentConnectionProfile(SshToolsConnectionProfile profile)

Parameters:: profile -

getCurrentConnectionProfile

public SshToolsConnectionProfile getCurrentConnectionProfile()

Returns:

editSettings

public boolean editSettings(SshToolsConnectionProfile profile)

Parameters:: profile -
Returns:

Class SshToolsApplicationSessionPanel

Nested Class Summary

Nested classes/interfaces inherited from class com.sshtools.common.ui.SshToolsApplicationPanel

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 com.sshtools.common.ui.SshToolsApplicationPanel

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 com.sshtools.common.ui.SshToolsApplicationPanel

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

Field Detail

PREF_CONNECTION_FILE_DIRECTORY

log

currentConnectionProfile

manager

Constructor Detail

SshToolsApplicationSessionPanel

SshToolsApplicationSessionPanel

Method Detail

getAdditionalConnectionTabs

addEventListener

requiresConfiguration

getId

openSession

onOpenSession

isConnected

setContainerTitle

setCurrentConnectionProfile

getCurrentConnectionProfile

editSettings