Package org.csstudio.opibuilder.runmode

Class OPIView

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.ViewPart

org.csstudio.opibuilder.runmode.OPIView

All Implemented Interfaces:

IOPIRuntime, IAdaptable, IExecutableExtension, IPersistable, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class OPIView
extends ViewPart
implements IOPIRuntime

RCP 'View' for display runtime

Similar to an RCP editor it is associated to an 'input', but provides only a view to that *.opi, executing its content.

Being a 'View' allows save/restore within a 'Perspective'.

RCP distinguishes instances via their secondary view ID. Each instances has a memento for storing arbitrary data, which we use for the 'input' (*.opi path and macros).

Secondary view IDs must be unique, they can't simply increment from "1" each time CSS is started because then a view with a previously used secondary ID will show the old content.

RCP only triggers saveState for views that are currently visible, typically on exit. This view will write the memento info directly to the underlying E4 model whenever the input changes.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	debug	Debug option, see .options file at plugin root
static final String	ID	View ID registered in plugin.xml for use as a 'default' view.
protected OPIRuntimeDelegate	opiRuntimeDelegate

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor	Description
OPIView()

Method Summary

Modifier and Type	Method	Description
void	createPartControl(Composite parent)
static String	createSecondaryID()
void	createToolbarButtons()
void	dispose()
<T> T	getAdapter(Class<T> adapter)
DisplayModel	getDisplayModel()
IEditorInput	getOPIInput()
OPIRuntimeDelegate	getOPIRuntimeDelegate()
void	init(IViewSite site, IMemento memento)
static boolean	isOpenFromPerspective()
void	positionFromModel()	Position the view according to location and size from the model.
void	saveState(IMemento memento)
void	setFocus()
static void	setOpenFromPerspective(boolean openFromPerspective)
void	setOPIInput(IEditorInput input)	Set the OPI input.
void	setOPIInput(IEditorInput input, boolean persist)
protected void	setTitleToolTip(String tool_tip)
void	setWorkbenchPartName(String name)	Set workbench part name.
String	toString()

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Field Details

ID

public static final String ID

View ID registered in plugin.xml for use as a 'default' view.

For views to be displayed in designated OPIRunnerPerspective.Position, that Position.name() is added to the basic ID

See Also:

• Constant Field Values

debug

public static final boolean debug

Debug option, see .options file at plugin root

opiRuntimeDelegate

protected OPIRuntimeDelegate opiRuntimeDelegate

Constructor Details

OPIView

public OPIView()

Method Details

createSecondaryID

public static String createSecondaryID()

Returns:

Unique secondary view ID for this instance of CSS

dispose

public void dispose()

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class WorkbenchPart

init

public void init(IViewSite site,
 IMemento memento)
          throws PartInitException

Specified by:

init in interface IViewPart

Overrides:

init in class ViewPart

Throws:

PartInitException

setOPIInput

public void setOPIInput(IEditorInput input,
 boolean persist)
                 throws PartInitException

Parameters:

input - Display file that this view should execute

persist - Persist the input to memento?

Throws:

PartInitException

setOPIInput

public void setOPIInput(IEditorInput input)
                 throws PartInitException

Description copied from interface: IOPIRuntime

Set the OPI input. The OPI Runtime will reload OPI from the input.

Specified by:

setOPIInput in interface IOPIRuntime

Parameters:

input - Display file that this view should execute

Throws:

PartInitException

createPartControl

public void createPartControl(Composite parent)

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

positionFromModel

public void positionFromModel()

Position the view according to location and size from the model. If the model location has negative values or is (0, 0), position within the parent window.

createToolbarButtons

public void createToolbarButtons()

saveState

public void saveState(IMemento memento)

Specified by:

saveState in interface IPersistable

Specified by:

saveState in interface IViewPart

Overrides:

saveState in class ViewPart

setFocus

public void setFocus()

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

setWorkbenchPartName

public void setWorkbenchPartName(String name)

Description copied from interface: IOPIRuntime

Set workbench part name. It calls setPartName() from editor or view to make it public visible.

Specified by:

setWorkbenchPartName in interface IOPIRuntime

setTitleToolTip

protected void setTitleToolTip(String tool_tip)

Overrides:

setTitleToolTip in class WorkbenchPart

getOPIRuntimeDelegate

public OPIRuntimeDelegate getOPIRuntimeDelegate()

getOPIInput

public IEditorInput getOPIInput()

Specified by:

getOPIInput in interface IOPIRuntime

Returns:

the OPI input of the runtime.

getDisplayModel

public DisplayModel getDisplayModel()

Specified by:

getDisplayModel in interface IOPIRuntime

Returns:

the display model in this runtime.

getAdapter

public <T> T getAdapter(Class<T> adapter)

Specified by:

getAdapter in interface IAdaptable

Overrides:

getAdapter in class WorkbenchPart

isOpenFromPerspective

public static boolean isOpenFromPerspective()

setOpenFromPerspective

public static void setOpenFromPerspective(boolean openFromPerspective)

toString

public String toString()

Overrides:

toString in class Object

Returns:

Debug info for view, shows ID and input