com.sshtools.common.ui
Class SessionProvider

java.lang.Object
  extended by com.sshtools.common.ui.SessionProvider

public class SessionProvider
extends java.lang.Object

Instances of this class are created by the SessionProviderFactory for each installed session provider. Instances of this class can be supplied to the SessionProviderFrame to create windows contains the session providers service

Version:
$Id: SessionProvider.java,v 1.1 2007/08/08 13:37:11 kathe Exp $
Author:
Lee David Painter

Field Summary
(package private)  java.lang.Class cls
           
(package private)  java.lang.String description
           
(package private)  java.lang.String id
           
(package private)  ResourceIcon largeicon
           
(package private)  char mnemonic
           
(package private)  java.lang.String name
           
(package private)  java.lang.Class optionsClass
           
(package private)  java.lang.Class[] propertypages
           
(package private)  ResourceIcon smallicon
           
(package private)  int weight
           
 
Constructor Summary
SessionProvider(java.lang.String id, java.lang.String name, java.lang.Class cls, java.lang.String description, java.lang.String mnemonic, java.lang.String smallicon, java.lang.String largeicon, java.lang.Class optionsClass, java.lang.Class[] propertypages, int weight)
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Compares this session provider against another object.
 java.lang.String getDescription()
          Get the description of the provider e.g.
 java.lang.String getId()
          Get the id of the provider e.g.
 ResourceIcon getLargeIcon()
          Get the large icon of the provider.
 char getMnemonic()
          Get the mnemonic character for key access
 java.lang.String getName()
          Get the name of the provider e.g.
 java.lang.Class getOptionsClass()
          Get the options class implementation
 java.lang.Class[] getPropertyPages()
          Get an array of class instances for the providers property pages.
 java.lang.Class getProviderClass()
          Get the class instance for the session providers implementation.
 ResourceIcon getSmallIcon()
          Get the small icon of the provider.
 int getWeight()
          Get the weight of the provider.
 java.lang.String toString()
          Returns the name of the provider.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

java.lang.String id

name

java.lang.String name

cls

java.lang.Class cls

description

java.lang.String description

mnemonic

char mnemonic

smallicon

ResourceIcon smallicon

largeicon

ResourceIcon largeicon

propertypages

java.lang.Class[] propertypages

weight

int weight

optionsClass

java.lang.Class optionsClass
Constructor Detail

SessionProvider

SessionProvider(java.lang.String id,
                java.lang.String name,
                java.lang.Class cls,
                java.lang.String description,
                java.lang.String mnemonic,
                java.lang.String smallicon,
                java.lang.String largeicon,
                java.lang.Class optionsClass,
                java.lang.Class[] propertypages,
                int weight)
Method Detail

getName

public java.lang.String getName()
Get the name of the provider e.g. 'Terminal Session'.

Returns:

getProviderClass

public java.lang.Class getProviderClass()
Get the class instance for the session providers implementation.

Returns:

getPropertyPages

public java.lang.Class[] getPropertyPages()
Get an array of class instances for the providers property pages.

Returns:

getDescription

public java.lang.String getDescription()
Get the description of the provider e.g. 'Opens a terminal session'

Returns:

getMnemonic

public char getMnemonic()
Get the mnemonic character for key access

Returns:

getWeight

public int getWeight()
Get the weight of the provider.

Returns:

getId

public java.lang.String getId()
Get the id of the provider e.g. 'sshterm'.

Returns:

getSmallIcon

public ResourceIcon getSmallIcon()
Get the small icon of the provider.

Returns:

getLargeIcon

public ResourceIcon getLargeIcon()
Get the large icon of the provider.

Returns:

getOptionsClass

public java.lang.Class getOptionsClass()
Get the options class implementation

Returns:

equals

public boolean equals(java.lang.Object obj)
Compares this session provider against another object. This method will only return true if the object provided is an instance of SessionProvider and that the provider id and implementation class are equal.

Overrides:
equals in class java.lang.Object
Parameters:
obj -
Returns:

toString

public java.lang.String toString()
Returns the name of the provider.

Overrides:
toString in class java.lang.Object
Returns: