Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sshtools.apps
Class SshToolsApplication  view SshToolsApplication download SshToolsApplication.java

java.lang.Object
  extended bycom.sshtools.apps.SshToolsApplication

public abstract class SshToolsApplication
extends java.lang.Object

Provides some common features for SshTools applications such as SshTerm and ShiFT

. When constructing the instance of this class, the Class of an implementation of SshToolsApplicationFrame must be provided.

Version:
$Id: SshToolsApplication.java,v 1.2 2003/01/20 14:28:12 t_magicthize Exp $

Field Summary
protected static java.util.Vector containers
           
protected  java.lang.Class defaultContainerClass
           
protected  org.apache.log4j.Logger log
           
protected  java.lang.Class panelClass
           
 
Constructor Summary
SshToolsApplication(java.lang.Class panelClass, java.lang.Class defaultContainerClass)
          Construct a new application
 
Method Summary
 void closeContainer(SshToolsApplicationContainer container)
          Check that a frame can close and exit when there are no more frames to close
 SshToolsApplicationContainer convertContainer(SshToolsApplicationContainer container, java.lang.Class newContainerClass)
          Convert a container to a different container
 void exit()
          Exit
abstract  java.lang.String getAboutAuthors()
          Return the authros for the about box
abstract  java.lang.String getAboutLicenseDetails()
          Return the license details for the about box
abstract  java.lang.String getAboutURL()
          Return the URL for the about box
abstract  javax.swing.Icon getApplicationLargeIcon()
          Return the application large icon
abstract  java.lang.String getApplicationName()
          Return the application name
abstract  java.lang.String getApplicationVersion()
          Return the application version
 SshToolsApplicationContainer getContainerAt(int idx)
          Return the container at the given index in the stack
 int getContainerCount()
          Return the number of containers this application currently has
 SshToolsApplicationContainer getContainerForPanel(SshToolsApplicationPanel panel)
          Return the container for a given panel
static void init(java.io.File prefs, java.lang.String[] args)
          The main entry method for an SshTools application.
 void newContainer()
          Create a new container of the default class
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

containers

protected static java.util.Vector containers

log

protected org.apache.log4j.Logger log

panelClass

protected java.lang.Class panelClass

defaultContainerClass

protected java.lang.Class defaultContainerClass
Constructor Detail

SshToolsApplication

public SshToolsApplication(java.lang.Class panelClass,
                           java.lang.Class defaultContainerClass)
Construct a new application

Method Detail

getApplicationName

public abstract java.lang.String getApplicationName()
Return the application name


getApplicationVersion

public abstract java.lang.String getApplicationVersion()
Return the application version


getApplicationLargeIcon

public abstract javax.swing.Icon getApplicationLargeIcon()
Return the application large icon


getAboutLicenseDetails

public abstract java.lang.String getAboutLicenseDetails()
Return the license details for the about box


getAboutURL

public abstract java.lang.String getAboutURL()
Return the URL for the about box


getAboutAuthors

public abstract java.lang.String getAboutAuthors()
Return the authros for the about box


exit

public void exit()
Exit


getContainerCount

public int getContainerCount()
Return the number of containers this application currently has


getContainerAt

public SshToolsApplicationContainer getContainerAt(int idx)
Return the container at the given index in the stack


getContainerForPanel

public SshToolsApplicationContainer getContainerForPanel(SshToolsApplicationPanel panel)
Return the container for a given panel


closeContainer

public void closeContainer(SshToolsApplicationContainer container)
Check that a frame can close and exit when there are no more frames to close


newContainer

public void newContainer()
                  throws SshToolsApplicationException
Create a new container of the default class


convertContainer

public SshToolsApplicationContainer convertContainer(SshToolsApplicationContainer container,
                                                     java.lang.Class newContainerClass)
                                              throws SshToolsApplicationException
Convert a container to a different container


init

public static void init(java.io.File prefs,
                        java.lang.String[] args)
                 throws java.lang.Exception
The main entry method for an SshTools application. The extending class should call this from its main method