com.borland.jbuilder.ide
Interface SetupPage

All Known Implementing Classes:
SetupPropertyPage, NestingSetupPropertyPage

public interface SetupPage

This interface defines some basic functions that a setup page that wants to appear in the Setup dialog must implement. That class should really extend one of SetupPropertyPage or NestingSetupPropertyPage classes, which themselves implement this, SetupPage, interface, but also extend the PropertyPage class. The pages that appear in the Enterprise Setup dialog are basically PropertyPages. The pages will appear as separate tabs in the dialog, if there is a class that extends the Setup abstract class, that registered itself with the SetupManager. If you want a page to appear under another Setup page, use the NestingSetupPropertyPage abstract class to implement your page.


Method Summary
 javax.swing.JPanel createSetupPanel()
          This function should return a JPanel with the specific controls necessary for the setup of your tool.
 java.lang.String getDescription()
          Implement this function to return a general description of the controls in the custom setup panel, and the consequences of various choices.
 

Method Detail

getDescription

public java.lang.String getDescription()
Implement this function to return a general description of the controls in the custom setup panel, and the consequences of various choices.
Returns:
The string to display at the top of the setup page for this tool.

createSetupPanel

public javax.swing.JPanel createSetupPanel()
This function should return a JPanel with the specific controls necessary for the setup of your tool.
Returns:
JPanel with specific setup controls.