de.postfuse.ui
Interface Script

All Superinterfaces:

Runnable

public interface Script
extends Runnable

Interface for all scripts

Author:

Peter

Method Summary

String	getCode() This Returns the source code of the Script for staring in File
boolean	getCodeEmbedded() If true the code is Saved embedded in the gml file
ScriptEnvironment	getEnvironment() You can add some entries to the environment by getting the environment and adding entries.
org.eclipse.core.resources.IFile	getFile()
String	getLabel() Get the name of the script, which is shown as an identifier for the script if it appears in the program.
void	run() Runs the Script This method should not throw any error !!!
void	setCodeEmbedded(boolean flag)

Method Detail

run

void run()

Runs the Script This method should not throw any error !!! The plugin which contains the script has the ability to log the errors itself. TODO Return-Object of the Script??

Specified by:

run in interface Runnable

getLabel

String getLabel()

Get the name of the script, which is shown as an identifier for the script if it appears in the program.

Returns:

the label

getCode

String getCode()

This Returns the source code of the Script for staring in File

Returns:

the Code of the Script, or null if not defined

getCodeEmbedded

boolean getCodeEmbedded()

If true the code is Saved embedded in the gml file

Returns:

if the code is embedded

setCodeEmbedded

void setCodeEmbedded(boolean flag)

Parameters:

flag - if the code should be embedded

getFile

org.eclipse.core.resources.IFile getFile()

Returns:

an IFile for eclipse Reference

getEnvironment

ScriptEnvironment getEnvironment()

You can add some entries to the environment by getting the environment and adding entries.

Returns:

an environment of other script used by this one