Overview | Package | Class | Use | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.togethersoft.openapi.ide
Interface IdeContext

public interface IdeContext

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

`IdeContext` is passed as a parameter to script's `run` method. This allows the script to extract information about the selection at the moment the script 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)

Method Summary
`IdeDiagram` | `getDiagram()` Returns an `IdeDiagram` containing selected elements.
`IdeElement[]` | `getElements()`
`Object` | `getUserParameter(String parameterName)` Returns the value of the specified user parameter.

Method Detail

### getDiagram

    public IdeDiagram getDiagram()

  Returns an `IdeDiagram` containing selected elements.
  Returns: `IdeDiagram` containing selected elements

### getElements

    public IdeElement[] getElements()

### getUserParameter

    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

Overview | Package | Class | Use | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD