oracle.ide.externaltools

Interface ExternalToolOptionsEnvironment

public interface ExternalToolOptionsEnvironment

The options environment is provided to external tool options page to provide information about the environment in which the create or edit external tools dialog is invoked.

Method Summary

Methods

Modifier and Type	Method and Description
MacroPicker	getMacroPicker(boolean onlyDirectories) Get a macro picker configured for the current environment.
MacroRegistry	getMacroRegistry() Get the macro registry.
MacroTextField	getMacroTextField(boolean onlyDirectories)
ExternalTool	getTool() Get the external tool being created or edited.
ExternalToolType	getType() Get the type of tool being created or edited.
boolean	isUniqueToolName(java.lang.String name) Returns true if the specified tool name is unique in the current editing session.
java.lang.String	makeUniqueName(java.lang.String name) Makes the specified tool name unique.
void	setUserCanFinishNow(boolean canFinish) Options pages can call this method to enable the finish button of the external tools wizard in create mode immediately.

Method Detail

setUserCanFinishNow

void setUserCanFinishNow(boolean canFinish)

Options pages can call this method to enable the finish button of the external tools wizard in create mode immediately. This can be used if you've already defaulted all remaining required properties of the external tool, and want to give the user the opportunity to quit the wizard immediately.

Parameters:

canFinish - if true, the user can finish the wizard now. Otherwise, they must go to the end of the wizard.

isUniqueToolName

boolean isUniqueToolName(java.lang.String name)

Returns true if the specified tool name is unique in the current editing session.

Parameters:

name - a tool name

Returns:

true if there are no other external tools with the specified name

makeUniqueName

java.lang.String makeUniqueName(java.lang.String name)

Makes the specified tool name unique.

Parameters:

name - a tool name

Returns:

if name is unique, returns name. Otherwise, returns a version of name altered to make it unique.

getMacroRegistry

MacroRegistry getMacroRegistry()

Get the macro registry.

getMacroPicker

MacroPicker getMacroPicker(boolean onlyDirectories)

Get a macro picker configured for the current environment.

Parameters:

onlyDirectories - if true, only directory macros will be displayed in the picker.

getMacroTextField

MacroTextField getMacroTextField(boolean onlyDirectories)

getType

ExternalToolType getType()

Get the type of tool being created or edited.

getTool

ExternalTool getTool()

Get the external tool being created or edited. You should normally avoid setting properties on the external tool when obtained from the environment - instead use the saveOptions() method in ExternalToolOptionsPage.