oracle.ide.externaltools
Interface ExternalToolOptionsPage

public interface ExternalToolOptionsPage

The external tools framework is extensible: you can register new external tool types. Each external tool type can have one or more options pages which are plugged into the external tool wizard. Each options page implements the ExternalToolOptionsPage interface.

Field Summary

static java.lang.String

COMPLETE_PROPERTY

Method Summary

void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Add a property change listener to this page.
javax.swing.JComponent	getGUI() Get the UI for this page.
java.lang.String	getHelpTopicID() Get the help topic ID for this page.
java.awt.Component	getInitialFocus() Get the initial focus component for this page.
java.lang.String	getPageName() Get the name of this options page.
boolean	isComplete() Is the page complete? This method should return true when all values on the page which are required fields have values.
void	loadOptions(ExternalTool tool, boolean isCreateMode) The options page should populate the UI from the specified ExternalTool object.
void	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Remove a property change listener.
void	saveOptions(ExternalTool tool, boolean isCreateMode) The options page should save the contents of the UI into the specified ExternalTool object.
void	setEnvironment(ExternalToolOptionsEnvironment env) Set the environment in which the page is being invoked.
boolean	validateOptions() The options page should verify that the values provided by the user are valid.

Field Detail

COMPLETE_PROPERTY

static final java.lang.String COMPLETE_PROPERTY

See Also:

Constant Field Values

Method Detail

getInitialFocus

java.awt.Component getInitialFocus()

Get the initial focus component for this page.

Returns:

a component that will have focus by default.

setEnvironment

void setEnvironment(ExternalToolOptionsEnvironment env)

Set the environment in which the page is being invoked. This provides context information and utilities to the page. This will always be called prior to loadOptions(), saveOptions() or validateOptions().

Parameters:

env - an ExternalToolOptionsEnvironment instance.

getGUI

javax.swing.JComponent getGUI()

Get the UI for this page. This should be a panel containing some explanatory text at the top, and controls for setting properties of tools of the type associated with this page.

Returns:

a UI component containing controls for this options page.

getPageName

java.lang.String getPageName()

Get the name of this options page.

Returns:

the name of this options page as displayed to the user. This should be a translated string where possible.

addPropertyChangeListener

void addPropertyChangeListener(java.lang.String property,
                               java.beans.PropertyChangeListener listener)

Add a property change listener to this page. The wizard will add itself as a listener for changes to the COMPLETE_PROPERTY. You should fire property change events whenever any mandatory fields on the page change value in a way that might require the next or ok buttons on the wizard to be enabled or disabled.

Parameters:

property - the property to listen for. The external tools wizard will always pass the value COMPLETE_PROPERTY into this method.

listener - the property listener to notify when mandatory values on this page may have caused the value of isComplete() to change.

removePropertyChangeListener

void removePropertyChangeListener(java.lang.String property,
                                  java.beans.PropertyChangeListener listener)

Remove a property change listener.

Parameters:

property - the property to remove a listener for

listener - the listener to remove

isComplete

boolean isComplete()

Is the page complete? This method should return true when all values on the page which are required fields have values. It shouldn't do any validation over and above checking that those fields have values.

You should fire a property change event to registered property change listeners if the value of this property may have changed.

Returns:

true if all required fields on the options page have values.

validateOptions

boolean validateOptions()

The options page should verify that the values provided by the user are valid. The implementation of this method is responsible for displaying any required alert UI to the user if there are any invalid values.

Returns:

true if the options specified by the user are valid, false otherwise.

saveOptions

void saveOptions(ExternalTool tool,
                 boolean isCreateMode)

The options page should save the contents of the UI into the specified ExternalTool object. This method will only be called when both isComplete() and isValid() return true.

Parameters:

tool - the external tool instance to save the options specified by the user in the UI to. The tool is guaranteed to be of the correct type for the ExternalToolType which provided this options page.

isCreateMode - flag used to indicate if the options page is currently being used in a wizard that's in create mode. You can use this flag to determine whether to default properties on later pages.

loadOptions

void loadOptions(ExternalTool tool,
                 boolean isCreateMode)

The options page should populate the UI from the specified ExternalTool object. This method will always be called prior to displaying the UI for this options page to the user.

Parameters:

tool - the external tool instance to load options into the UI from. The tool is guaranteed to be of the correct type for the ExternalToolType which provided this options page.

isCreateMode - flag used to indicate if the options page is currently being used in a wizard that's in create mode.

getHelpTopicID

java.lang.String getHelpTopicID()

Get the help topic ID for this page.

Returns:

the help topic ID