com.borland.jbuilder.ide
Class Setup
java.lang.Object
|
+--com.borland.jbuilder.ide.Setup
- public abstract class Setup
- extends java.lang.Object
The Setup abstract class is provided to allow adding custom tool setups to
JBuilder. These setups will appear in an "Enterprise Setup" dialog, available
from the "Enterprise Setup" menu item under JBuilder's "Tools" menu.
Each Setup will have its own tab in that dialog, with the getName() name on
that tab. The contents of the tab will be a SetupPropertyPage or
NestingSetupPropertyPage extended classs returned by getSetupPropertyPage().
If isEnabled() returns false, the page will not be added to the dialog.
Constructor Summary |
Setup()
|
Method Summary |
abstract java.lang.String |
getName()
Returns the name that will be used to refer to this setup. |
PropertyPageFactory |
getPageFactory(Browser browser)
Creates a page factory that will in turn create the setup page for this setup. |
protected abstract PropertyPage |
getSetupPropertyPage(Browser browser)
This function returns the setup page that will display the controls
necessary for setting up the custom tool. |
abstract boolean |
isEnabled()
Allows implementation to check for various conditions under which this
setup should not be enabled -- for example, some setups are only
appropriate if the current version of JBuilder is Enterprise. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CATEGORY
public static final java.lang.String CATEGORY
LAST_SELECTED_SETUP_NAME
public static final GlobalProperty LAST_SELECTED_SETUP_NAME
Setup
public Setup()
getName
public abstract java.lang.String getName()
- Returns the name that will be used to refer to this setup. This name will
also appear as the name of the tab that displays the page for this Setup
- Returns:
- the name used to refer to this setup.
isEnabled
public abstract boolean isEnabled()
- Allows implementation to check for various conditions under which this
setup should not be enabled -- for example, some setups are only
appropriate if the current version of JBuilder is Enterprise.
- Returns:
- A boolean indicating whether this Setup page should be enabled.
getSetupPropertyPage
protected abstract PropertyPage getSetupPropertyPage(Browser browser)
- This function returns the setup page that will display the controls
necessary for setting up the custom tool.
- Returns:
- A factory that creates a property page with necessary setup controls.
getPageFactory
public PropertyPageFactory getPageFactory(Browser browser)
- Creates a page factory that will in turn create the setup page for this setup.