Right Java tools for J2EE, Web Service, Grid and more. Open source and Enterprise.

|Home | Products | Documents | Downloads | Purchase | Support | Company | Partners | Contact |

com.acelet.s
Interface SuperBean

All Known Implementing Classes:

Envoy

public interface SuperBean

SuperBean defines methods for visible beans used by Super.

Changes: 2001.10.31: verson 3.1: merget BeanInterface into SuperBean
Changes: 2002.03.17: version 3.2: add getLicenseType()
Changes: 2003.03.24: version 3.3: add getMenuItem()

Field Summary

static int	DISPLAY_TYPE_DIALOG DISPLAY_TYPE_DIALOG
static int	DISPLAY_TYPE_INTERNALFRAME DISPLAY_TYPE_INTERNALFRAME
static int	DISPLAY_TYPE_NOTVISIBLE DISPLAY_TYPE_NOTVISIBLE
static java.lang.String	TYPE_ADMIN Bean type for using with com.acelet.lib.BeanInterface.getType().
static java.lang.String	TYPE_ENVOY Bean type for using with com.acelet.lib.BeanInterface.getType().
static java.lang.String	TYPE_MODULE Bean type for using with com.acelet.lib.BeanInterface.getType().
static java.lang.String	TYPE_MONITOR Bean type for using with com.acelet.lib.BeanInterface.getType().
static java.lang.String	TYPE_TUNE Bean type for using with com.acelet.lib.BeanInterface.getType().
static int	VERSION VERSION is the version number of this interface specification

Method Summary

void	beforeBegin(Envoy envoy) beforeBegin set Envoy You can use this method as the "start" method for the bean.
void	checkLicense() checkLicense checks license for this SuperBean.
java.lang.String	getDescription(java.util.Locale locale) getDescription returns description of the bean.
int	getDisplayType() getDisplayType returns description of the bean.
java.lang.String	getHelpSetName(java.util.Locale locale) getHelpSet returns javax.help.HelpSet name, with specified locale.
java.lang.String	getHelpTopic() getHelpTopic returns help topic for this SuperBean.
java.lang.String	getLicenseType() getLicenseType check license for this bean.
java.lang.Object	getMenuItem() getMenuItem returns a JMenuItem, which is used by Super to construct a visible bean.
java.lang.String	getNameText(java.util.Locale locale) getNameText returns the name for menu and window title.
java.lang.Object	getPanel() getPanel returns a JPanel, which is used by Super to construct a visible bean.
java.lang.String	getType() getType return the type of this component.
boolean	install(java.lang.String beanboxDirName, java.lang.String serverHomeDirName) install does all necessary work to install this bean.
boolean	installLicense(java.lang.String beanboxDirName) installLicense does all necessary work to install a license for this bean.
void	setJDesktopPane(java.lang.Object desktopPane) setJDesktopPane set the JDesktopPane.
boolean	uninstall(java.lang.String beanboxDirName, java.lang.String serverHomeDirName) uninstall does all necessary work to uninstall this bean.

Field Detail

VERSION

static final int VERSION

VERSION is the version number of this interface specification

See Also:

Constant Field Values

DISPLAY_TYPE_DIALOG

static final int DISPLAY_TYPE_DIALOG

DISPLAY_TYPE_DIALOG

See Also:

Constant Field Values

DISPLAY_TYPE_INTERNALFRAME

static final int DISPLAY_TYPE_INTERNALFRAME

DISPLAY_TYPE_INTERNALFRAME

See Also:

Constant Field Values

DISPLAY_TYPE_NOTVISIBLE

static final int DISPLAY_TYPE_NOTVISIBLE

DISPLAY_TYPE_NOTVISIBLE

See Also:

Constant Field Values

TYPE_ENVOY

static final java.lang.String TYPE_ENVOY

Bean type for using with com.acelet.lib.BeanInterface.getType(). This type of beans will be under menu Server.

See Also:

Constant Field Values

TYPE_MODULE

static final java.lang.String TYPE_MODULE

Bean type for using with com.acelet.lib.BeanInterface.getType(). This type of beans will be under menu Module.

See Also:

Constant Field Values

TYPE_MONITOR

static final java.lang.String TYPE_MONITOR

Bean type for using with com.acelet.lib.BeanInterface.getType(). This type of beans will be under menu Monitor.

See Also:

Constant Field Values

TYPE_ADMIN

static final java.lang.String TYPE_ADMIN

Bean type for using with com.acelet.lib.BeanInterface.getType(). This type of beans will be under menu Tune.

See Also:

Constant Field Values

TYPE_TUNE

static final java.lang.String TYPE_TUNE

Bean type for using with com.acelet.lib.BeanInterface.getType(). This type of beans will be under menu Tune.

See Also:

Constant Field Values

Method Detail

beforeBegin

void beforeBegin(Envoy envoy)
                 throws java.lang.Exception

beforeBegin set Envoy You can use this method as the "start" method for the bean.

Throws:

java.lang.Exception

checkLicense

void checkLicense()
                  throws java.lang.Exception

checkLicense checks license for this SuperBean. If there is no license or license is not valid, it throws Exception.

Throws:

java.lang.Exception

getLicenseType

java.lang.String getLicenseType()

getLicenseType check license for this bean. Return LICENSE_TYPE_NON_LICENSED if it is not licensed. can not be null.

getDescription

java.lang.String getDescription(java.util.Locale locale)

getDescription returns description of the bean.

getDisplayType

int getDisplayType()

getDisplayType returns description of the bean.

getHelpSetName

java.lang.String getHelpSetName(java.util.Locale locale)

getHelpSet returns javax.help.HelpSet name, with specified locale.

getHelpTopic

java.lang.String getHelpTopic()

getHelpTopic returns help topic for this SuperBean.

getMenuItem

java.lang.Object getMenuItem()
                             throws java.lang.Exception

getMenuItem returns a JMenuItem, which is used by Super to construct a visible bean. This is the main panle for the bean.

Throws:

java.lang.Exception

getNameText

java.lang.String getNameText(java.util.Locale locale)

getNameText returns the name for menu and window title.

getPanel

java.lang.Object getPanel()

getPanel returns a JPanel, which is used by Super to construct a visible bean. This is the main panle for the bean.

getType

java.lang.String getType()

getType return the type of this component.

install

boolean install(java.lang.String beanboxDirName,
                java.lang.String serverHomeDirName)
                throws java.lang.Exception

install does all necessary work to install this bean. Returns true if the bean file (jar file) is copied to right location by this method, so the caller does not need to copy it. Returns false otherwise.
You can copy support files under directory beanbox or its sub-directories here. Copy files from out side to directory beanbox is not recommeded for end users.

Throws:

java.lang.Exception

installLicense

boolean installLicense(java.lang.String beanboxDirName)
                       throws java.lang.Exception

installLicense does all necessary work to install a license for this bean.

Returns true if the license is installed successfuly. Returns false otherwise.

Throws:

java.lang.Exception

setJDesktopPane

void setJDesktopPane(java.lang.Object desktopPane)

setJDesktopPane set the JDesktopPane. The desktopPane is the mast window of the program.

uninstall

boolean uninstall(java.lang.String beanboxDirName,
                  java.lang.String serverHomeDirName)
                  throws java.lang.Exception

uninstall does all necessary work to uninstall this bean. Returns true if the bean file (jar file) is deleted by this method, so the caller does not need to delete it. Returns false otherwise.

Throws:

java.lang.Exception