Package com.sshtools.common.ui
Class SshToolsApplicationPanel
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.sshtools.common.ui.SshToolsApplicationPanel
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
- Direct Known Subclasses:
SshToolsApplicationClientPanel
,SshToolsApplicationSessionPanel
- Version:
- $Revision: 1.23 $
- Author:
- $author$
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Vector
protected Vector
protected HashMap
protected SshToolsApplication
protected SshToolsApplicationContainer
protected JPopupMenu
protected org.apache.commons.logging.Log
protected JMenuBar
protected JToolBar
protected boolean
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
ConstructorsConstructorDescriptionCreates a new SshToolsApplicationPanel object.Creates a new SshToolsApplicationPanel object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFavorite
(StandardAction action) abstract boolean
canClose()
Called by the application framework to test the closing stateabstract void
close()
Called by the application framework to close the panelvoid
deregisterAction
(StandardAction action) Deregister an actionGet an action by namegetActionMenu
(String actionMenuName) Gets a menu by nameGet the application attached to the panelGets the container for this panel.Get the context menuabstract ResourceIcon
getIcon()
Get the icon for the panelGet the main menuGet the status barGets the toolbarvoid
init
(SshToolsApplication application) Initialize the panelabstract boolean
Returns the connected state of the panelboolean
Determine if the toolbar, menu and statusbar are visiblevoid
Rebuild all the action components such as toobar, context menuvoid
registerAction
(StandardAction action) Register a new actionvoid
Register a new menuvoid
setActionVisible
(String name, boolean visible) Set an actions visible stateabstract void
Called by the application framework when a change in connection state has occured.void
setContainer
(SshToolsApplicationContainer container) Sets the container for this panelvoid
setContainerTitle
(File file) Set the title of the containervoid
setMenuBarVisible
(boolean visible) Set the visible state of the menu barvoid
setStatusBarVisible
(boolean visible) Set the visible state of the statusbarvoid
setToolBarVisible
(boolean visible) Set the visible state of the toolbarvoid
setToolsVisible
(boolean visible) Set the visible state of all tools.static void
showErrorMessage
(Component parent, String mesg, String title, Throwable exception) Show an error message with toggable detailstatic void
showErrorMessage
(Component parent, String title, Throwable exception) Show an error message with detailvoid
showExceptionMessage
(String title, String message) Show an exception messagevoid
Show the options dialogMethods 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Field Details
-
log
protected org.apache.commons.logging.Log log -
application
-
toolBar
-
contextMenu
-
container
-
actions
-
actionsVisible
-
toolsVisible
protected boolean toolsVisible -
actionMenus
-
-
Constructor Details
-
SshToolsApplicationPanel
public SshToolsApplicationPanel()Creates a new SshToolsApplicationPanel object. -
SshToolsApplicationPanel
Creates a new SshToolsApplicationPanel object.- Parameters:
mgr
-
-
-
Method Details
-
canClose
public abstract boolean canClose()Called by the application framework to test the closing state- Returns:
-
close
public abstract void close()Called by the application framework to close the panel -
setAvailableActions
public abstract void setAvailableActions()Called by the application framework when a change in connection state has occured. The available actions should be enabled/disabled in this methods implementation -
setActionVisible
Set an actions visible state- Parameters:
name
-visible
-
-
getContainer
Gets the container for this panel.- Returns:
-
setContainer
Sets the container for this panel- Parameters:
container
-
-
registerActionMenu
Register a new menu- Parameters:
actionMenu
-
-
getActionMenu
Gets a menu by name- Parameters:
actionMenuName
-- Returns:
-
getAction
Get an action by name- Parameters:
name
-- Returns:
-
deregisterAction
Deregister an action- Parameters:
action
-
-
registerAction
Register a new action- Parameters:
action
-
-
init
Initialize the panel- Parameters:
application
-- Throws:
SshToolsApplicationException
-
showOptions
public void showOptions()Show the options dialog -
rebuildActionComponents
public void rebuildActionComponents()Rebuild all the action components such as toobar, context menu -
isToolsVisible
public boolean isToolsVisible()Determine if the toolbar, menu and statusbar are visible- Returns:
-
addFavorite
-
setMenuBarVisible
public void setMenuBarVisible(boolean visible) Set the visible state of the menu bar- Parameters:
visible
-
-
setToolBarVisible
public void setToolBarVisible(boolean visible) Set the visible state of the toolbar- Parameters:
visible
-
-
setStatusBarVisible
public void setStatusBarVisible(boolean visible) Set the visible state of the statusbar- Parameters:
visible
-
-
setToolsVisible
public void setToolsVisible(boolean visible) Set the visible state of all tools. This will set the toolbar, menu and status bar visible states to the value provided.- Parameters:
visible
-
-
showExceptionMessage
Show an exception message- Parameters:
title
-message
-
-
showErrorMessage
Show an error message with detail- Parameters:
parent
-title
-exception
-
-
showErrorMessage
public static void showErrorMessage(Component parent, String mesg, String title, Throwable exception) Show an error message with toggable detail- Parameters:
parent
-mesg
-title
-exception
-
-
isConnected
public abstract boolean isConnected()Returns the connected state of the panel- Returns:
-
setContainerTitle
Set the title of the container- Parameters:
file
-
-
getToolBar
Gets the toolbar- Returns:
-
getContextMenu
Get the context menu- Returns:
-
getJMenuBar
Get the main menu- Returns:
-
getStatusBar
Get the status bar- Returns:
-
getApplication
Get the application attached to the panel- Returns:
-
getIcon
Get the icon for the panel- Returns:
-