Package org.csstudio.opibuilder.widgetActions

Class AbstractExecuteScriptAction

java.lang.Object

org.csstudio.opibuilder.widgetActions.AbstractWidgetAction

org.csstudio.opibuilder.widgetActions.AbstractExecuteScriptAction

All Implemented Interfaces:

IAdaptable

Direct Known Subclasses:

ExecuteJavaScriptAction, ExecutePythonScriptAction

public abstract class AbstractExecuteScriptAction
extends AbstractWidgetAction

The abstract action for executing script.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_EMBEDDED
static final String	PROP_PATH
static final String	PROP_SCRIPT_TEXT

Fields inherited from class org.csstudio.opibuilder.widgetActions.AbstractWidgetAction

PROP_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
AbstractExecuteScriptAction()

Method Summary

Modifier and Type	Method	Description
protected void	closeReader()
protected void	configureProperties()
protected abstract AbstractWidgetProperty<?>	createEmbeddedScriptProperty(String prop_id, String description, WidgetPropertyCategory category, String defaultValue)
protected IPath	getAbsolutePath()
String	getDefaultDescription()
protected abstract String	getFileExtension()
protected InputStream	getInputStream()	Get raw InputStream of the script file.
protected IPath	getPath()
protected BufferedReader	getReader()	Get reader of the script file.An instance will be created for later to use.
protected String	getScriptText()
protected boolean	isEmbedded()

Methods inherited from class org.csstudio.opibuilder.widgetActions.AbstractWidgetAction

addProperty, dispose, getActionType, getAdapter, getAllProperties, getAllPropertyIDs, getCopy, getDescription, getProperty, getPropertyValue, getWidgetModel, isEnabled, run, setEnabled, setPropertyValue, setWidgetModel

Methods inherited from class java.lang.Object

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

Field Details

PROP_PATH

public static final String PROP_PATH

See Also:

• Constant Field Values

PROP_EMBEDDED

public static final String PROP_EMBEDDED

See Also:

• Constant Field Values

PROP_SCRIPT_TEXT

public static final String PROP_SCRIPT_TEXT

See Also:

• Constant Field Values

Constructor Details

AbstractExecuteScriptAction

public AbstractExecuteScriptAction()

Method Details

configureProperties

protected void configureProperties()

Specified by:

configureProperties in class AbstractWidgetAction

getPath

protected IPath getPath()

getAbsolutePath

protected IPath getAbsolutePath()

isEmbedded

protected boolean isEmbedded()

createEmbeddedScriptProperty

protected abstract AbstractWidgetProperty<?> createEmbeddedScriptProperty(String prop_id,
 String description,
 WidgetPropertyCategory category,
 String defaultValue)

getScriptText

protected String getScriptText()

getDefaultDescription

public String getDefaultDescription()

Overrides:

getDefaultDescription in class AbstractWidgetAction

getReader

protected BufferedReader getReader()
                            throws Exception

Get reader of the script file.An instance will be created for later to use. Muse call closeReader() to close this reader.

Returns:

the reader

Throws:

Exception

closeReader

protected void closeReader()

getInputStream

protected InputStream getInputStream()
                              throws Exception

Get raw InputStream of the script file. Make sure to call close() of the returned instance.

Returns:

InputStream of the script file.

Throws:

Exception

getFileExtension

protected abstract String getFileExtension()