com.togethersoft.openapi.ide
Interface IdeManager

public interface IdeManager

Interface IdeManager provides the entire IDE's fuctionality.

This interface supplies methods relating to the overall IDE functionality, such as saving the opened files or starting a
new process.

IdeManager provides a convenient mechanism for retrieving additional
information about the result of certain actions. This information is stored in the
IdeErrorInfo object accessible through the setErrorInfo
and performCheck methods.

Current IdeManager can be obtained via static
IdeManagerAccess.getManager method:

IdeManager manager = IdeManagerAccess.getManager();

Author:

TogetherSoft

See Also: IdeAccess, performCheck(com.togethersoft.openapi.ide.IdeErrorCheck), setErrorInfo(com.togethersoft.openapi.ide.IdeErrorInfo)

public void addCommandAndWait(Runnable command)

Adds ceratin command to the commands queue and waits while this command is not executed.

Parameters:

command Runnable object to be added to the queue

Since:

Together 4.0

public void addCommandToQueue(Runnable command)

Adds specified command to the commands queue.

Parameters:

command Runnable object to be added to the queue

public void addCommandToQueue(Runnable command, String name)

Adds specified command, identified by it's name, to the commands queue.

Parameters:

command Runnable object to be added to the queue

name String name of this command

Since:

Together 4.0

public String buildDiagramURL(RwiDiagram diagram, RwiElement element)

Creates URL of a specific kind referring to the specified element of the diagram.

Parameters:

diagram RwiDiagram where this element is located

element RwiElement object representing the target element

Returns: String URL that contains information about the position of the specified element

public String buildEditorURL(String url, TextPosition position)

Produces URL of a specific kind, referring to the position in a certain file.
If this file can be opened in the editor, returns URL of the position in this file; otherwise returns initial URL.

Parameters:

url String URL of a file

position TextPosition instance

Returns: String URL that contains information about the position in this file,
if this file can be opned in the editor; String initial URL otherwise

See Also:

buildEditorURL(java.lang.String,int)

public String buildEditorURL(String url, int offset)

Produces URL of a specific kind, referring to the offset in a certain file.
If this file can be opened in the editor, returns URL of the position in this file; otherwise returns initial URL.

Parameters:

url String URL of a file

position int offset in the file

Returns: String URL that contains information about the position in this file,
if this file can be opned in the editor; String initial URL otherwise

See Also:

buildEditorURL(java.lang.String,com.togethersoft.openapi.util.text.TextPosition)

public Process exec(String command)

Executes specified command in a separate process.

Parameters:

command String system command to be executed

Returns: Process object for managing the subprocess

public Process exec(String command, String fileForOut)

Executes the specified command in a separate process, with the specifed output file.

Parameters:

command String system command to be executed

fileForOut String name of the output file of this process

Returns: Process object for managing the subprocess

public String expandMacros(IdeContext context, String command)

Replaces macros in command with the corresponding values.
See external tools guide for supported macro set.

Parameters:

context IdeContext object that represents the Context
(e.g. current selection) to be used by the macros. Some macros need
non-global information (class, file, etc.) to execute. If null is passed, only those macros that do not
require this information can be executed

command String Source for macro substitution

Returns: null if some macros cannot be executed, or
String command with macros replaced with the corresponding values,
if all macros where successfully processed.

public String[] getArguments()

Returns the list of arguments passed to 'main' method.

Returns: String array with arguments

public IdeCommandManager getCommandManager()

Deprecated.

Returns: IdeCommandManager

See Also:

IdeCommandManager

public IdeConfigManager getConfigManager()

Deprecated.

Returns: IdeConfigManager

See Also:

IdeConfigManager

public IdeDiagramManager getDiagramManager()

Deprecated.

Returns: IdeDiagramManager

See Also:

IdeDiagramManager

public IdeEditorManager getEditorManager()

Deprecated.

Returns: IdeEditorManager

See Also:

IdeEditorManager

public String getHomeDirectory()

Returns fully qualified path of Together's root directory. For example, if Together is
installed in C:\Cases\Together, then this method will return "C:\Cases\Together".

Returns: String fully qualified path of Together's root directory

public IdeMessageManager getMessageManager()

Deprecated.

Returns: IdeMessageManager

See Also:

IdeMessageManager

public String getModuleHomeDirectory(Class moduleClass)

Returns home folder for the module, defined by it's class.

Parameters:

module Class

Returns: String home folder for this module

Since:

Together 4.0

public IdeProgressIndicator getProgressIndicator()

public IdeProjectManager getProjectManager()

public String getTempFile()

public Locale getUILocale()

public IdeUndoManager getUndoManager()

public IdeWindowManager getWindowManager()

public boolean isGUIEnabled()

public boolean isModuleActive(String moduleClassName)

public boolean isModuleServiceAvailable(String serviceName)

public void navigateByURL(String url)

public void openApplicationHelp(String topic, Component parent)

public void openHelp(String url)

public void openURL(String url)

public IdeErrorInfo performCheck(IdeErrorCheck check)

public void printStatus(String text)

public void saveAll()

public void setErrorInfo(IdeErrorInfo info)

public void showHelp(String targetID, boolean openInModalDialog, Component parent)

public void showHelp(java.net.URL url, boolean openInModalDialog, Component parent)

public void synchronize()