Package org.csstudio.opibuilder.widgetActions

Class OpenDisplayAction

java.lang.Object

org.csstudio.opibuilder.widgetActions.AbstractWidgetAction

org.csstudio.opibuilder.widgetActions.OpenDisplayAction

All Implemented Interfaces:

IAdaptable

public class OpenDisplayAction
extends AbstractWidgetAction

Action for executing a display.

Properties, configured when the action is added to a widget, suggest how the display should be opened: Replace existing display, or open new standalone shell, or ..

User can override via key modifiers:

• Ctrl - Opens a new view in existing workbench window
• Shift - Open a new view in new workbench window
• Ctrl + Shift - Open a new standalone shell

These key modifiers need to be passed by the context menu or whatever usually invokes the 'run()' method by calling the specialized runWithModifiers()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_MACROS
static final String	PROP_MODE
static final String	PROP_PATH

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

PROP_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
OpenDisplayAction()

Method Summary

Modifier and Type	Method	Description
protected void	configureProperties()
WidgetActionFactory.ActionType	getActionType()
String	getDefaultDescription()
protected RunModeService.DisplayMode	getDisplayMode()
protected MacrosInput	getMacrosInput()
protected IPath	getPath()
protected void	handleLegacySettings(org.jdom2.Element path_element)
void	run()
void	runWithModifiers(boolean ctrlPressed, boolean shiftPressed)	Run the action, i.e. open display, with optional modifiers

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

addProperty, dispose, getAdapter, getAllProperties, getAllPropertyIDs, getCopy, getDescription, getProperty, getPropertyValue, getWidgetModel, isEnabled, 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_MACROS

public static final String PROP_MACROS

See Also:

• Constant Field Values

PROP_MODE

public static final String PROP_MODE

See Also:

• Constant Field Values

Constructor Details

OpenDisplayAction

public OpenDisplayAction()

Method Details

configureProperties

protected void configureProperties()

Specified by:

configureProperties in class AbstractWidgetAction

handleLegacySettings

protected void handleLegacySettings(org.jdom2.Element path_element)

runWithModifiers

public void runWithModifiers(boolean ctrlPressed,
 boolean shiftPressed)

Run the action, i.e. open display, with optional modifiers

Parameters:

ctrlPressed - True if Ctrl was pressed while invoking the action

shiftPressed - True if Shift was held while invoking the action

run

public void run()

Specified by:

run in class AbstractWidgetAction

getPath

protected IPath getPath()

getMacrosInput

protected MacrosInput getMacrosInput()

getDisplayMode

protected RunModeService.DisplayMode getDisplayMode()

getActionType

public WidgetActionFactory.ActionType getActionType()

Specified by:

getActionType in class AbstractWidgetAction

getDefaultDescription

public String getDefaultDescription()

Overrides:

getDefaultDescription in class AbstractWidgetAction