javax.ide

Class IDE

java.lang.Object

javax.ide.Service

javax.ide.IDE

public abstract class IDE
extends Service

This is the object that centralizes general IDE environment information and services. Extensions use the IDE interface to access standard services.

Extensions can locate the IDE environment object using the getIDE() method.

IDE providers must extend this class and provide an implementation of getProductName() and getUserHome().

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
IDE()

Method Summary

Modifier and Type	Method and Description
protected void	addIDEListener(IDEListener listener)
protected void	fireIDEActivated() Fire an IDEActivated event to all registered listeners.
protected void	fireIDEDeactivated() Fire an IDEDeactivated event to all registered listeners.
ActionRegistry	getActionRegistry() Extension that need to lookup an action use ActionRegistry service.
abstract View	getActiveView() Get the currently active view.
BuildSystem	getBuildSystem() Get the BuildSystem.
CommandProcessor	getCommandProcessor() Get the CommandProcessor.
Debugger	getDebugger() Get the Debugger.
DocumentFactory	getDocumentFactory() Get the DocumentFactory.
EditorManager	getEditorManager() Get the EditorManager.
Version	getEDKVersion() Get Extension Development Kit version number.
ExtensionRegistry	getExtensionRegistry() Get the ExtensionRegistry.
GUIUtilities	getGUIUtilities() Get the GUIUtilities.
static IDE	getIDE() Get the ide implementation.
LogManager	getLogManager() Get the LogManager.
abstract View	getMainWindow() Get the main window.
abstract java.lang.String	getProductName() Get the IDE product name.
PropertyPageRegistry	getPropertyPageRegistry() Get the PropertyPageRegistry.
abstract java.net.URI	getUserHome() Get the directory where the user work is saved.
WizardManager	getWizardManager() Get the WizardManager.
protected void	initialize() Initialize this manager.

Methods inherited from class javax.ide.Service

cloneLoadedServices, getService, resetAllServices, setLoadedServices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IDE

public IDE()

Method Detail

getProductName

public abstract java.lang.String getProductName()

Get the IDE product name.

Returns:

The product name of the IDE provider. Must not be null.

getMainWindow

public abstract View getMainWindow()

Get the main window.

Returns:

the main window. Must not be null.

getActiveView

public abstract View getActiveView()

Get the currently active view.

Returns:

the currently active view. Must not be null.

getEDKVersion

public Version getEDKVersion()

Get Extension Development Kit version number.

Returns:

The current Extension Software Development Kit version supported by the IDE provider. For this version of the ESDK, this must be 1.0

getUserHome

public abstract java.net.URI getUserHome()

Get the directory where the user work is saved. This is the default directory under which end user documents are saved. Extension use the returned value to suggest the filepath where a new document is going to be created when the user invokes a document creation wizard.

Returns:

The directory where the user work is stored. Must not be null, must be a file: scheme URI.

getActionRegistry

public final ActionRegistry getActionRegistry()

Extension that need to lookup an action use ActionRegistry service.

Returns:

The service used to find registered actions. Must not be null.

getExtensionRegistry

public final ExtensionRegistry getExtensionRegistry()

Get the ExtensionRegistry.

Returns:

The extension registry service. Must not be null.

getDocumentFactory

public final DocumentFactory getDocumentFactory()

Get the DocumentFactory.

Returns:

The document factory. Must not be null.

getEditorManager

public final EditorManager getEditorManager()

Get the EditorManager.

Returns:

The editor manager. Must not be null.

getCommandProcessor

public final CommandProcessor getCommandProcessor()

Get the CommandProcessor.

Returns:

The command processor. Must not be null.

getLogManager

public final LogManager getLogManager()

Get the LogManager.

Returns:

The log manager. Must not be null.

getWizardManager

public final WizardManager getWizardManager()

Get the WizardManager.

Returns:

The wizard manager. Must not be null.

getDebugger

public final Debugger getDebugger()

Get the Debugger.

Returns:

the debugger. Must not be null.

getBuildSystem

public final BuildSystem getBuildSystem()

Get the BuildSystem.

Returns:

the build system. Must not be null.

getPropertyPageRegistry

public final PropertyPageRegistry getPropertyPageRegistry()

Get the PropertyPageRegistry.

Returns:

the property page registry. Must not be null.

getGUIUtilities

public final GUIUtilities getGUIUtilities()

Get the GUIUtilities.

Returns:

the GUI utilities. These utilities allow extension writers to use standard IDE dialogs in reporting extension specific errors, warnings, etc.. Must not be null.

addIDEListener

protected final void addIDEListener(IDEListener listener)

fireIDEActivated

protected final void fireIDEActivated()

Fire an IDEActivated event to all registered listeners.

fireIDEDeactivated

protected final void fireIDEDeactivated()

Fire an IDEDeactivated event to all registered listeners.

initialize

protected void initialize()

Description copied from class: Service

Initialize this manager. This is called the first time a manager is retrieved programmatically. The manager should process necessary information from the extension manifest to initialize itself.

This implementation does nothing.

Overrides:

initialize in class Service

getIDE

public static final IDE getIDE()

Get the ide implementation.

Returns:

the ide. Must not be null.