com.togethersoft.openapi.ide
Interface IdeContext

public interface IdeContext

Contains information about selected elements at the moment the module was called.

IdeContext is passed as a parameter to run method of the module. This allows
the module to extract information about the selection at the moment the module was called, because at the moment
the run method starts, the selection might be changed.

Author:

TogetherSoft

See Also: IdeScript.run(com.togethersoft.openapi.ide.IdeContext)

public IdeDiagram getDiagram()

Returns an IdeDiagram containing selected elements.

Returns: IdeDiagram containing selected elements

public IdeDiagramElement[] getDiagramElements()

Deprecated.

Returns: IdeDiagramElements array of selected IdeDiagram elements

public IdeElement[] getElements()

Since:

Together 3.1

public String[] getFileNames()

Deprecated.

Returns: String[] array of file names of the selected elements.

public RwiElement[] getRwiElements()

Deprecated.

Returns: an array of selected RwiElements.

See Also:

RwiReference, RwiElement, RwiDiagram, getRwiReferences()

public RwiReference[] getRwiReferences()

Deprecated.

Returns: an array of RwiReferences to selected RwiElements.

See Also:

RwiReference, RwiElement, RwiDiagram, getRwiElements()

public Object getUserParameter(String parameterName)

Returns the value of the specified user parameter. User parameters are usually defined in the config files.

Parameters:

parameterName String name of the user parameter

Returns: Object value of this user parameter