org.eclipse.eavp.viz.service.csv

Class CSVPlotEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

org.eclipse.eavp.viz.service.csv.CSVPlotEditor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, org.eclipse.ui.IEditorPart, org.eclipse.ui.ISaveablePart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class CSVPlotEditor
extends org.eclipse.ui.part.EditorPart

This is an editor for displaying an SWT XYGraph used to draw plots from CSV files. It is opened by the associated visualization views in org.eclipse.eavp.viz.

Author:

Matthew Wang, Taylor Patterson, Anna Wojtowicz, Jordan Deyton, Alex McCaskey, Kasper Gammeltoft - Viz refactor, enabled the editor to work properly with ISeries rather than SeriesProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID The ID for this editor.

Fields inherited from interface org.eclipse.ui.IEditorPart

PROP_DIRTY, PROP_INPUT

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
CSVPlotEditor() The constructor

Method Summary

Modifier and Type	Method and Description
void	createPartControl(org.eclipse.swt.widgets.Composite parent) This operation sets up the Composite that contains the VisIt canvas and create the VisIt widget.
void	doSave(org.eclipse.core.runtime.IProgressMonitor monitor)
void	doSaveAs()
org.eclipse.swt.widgets.Canvas	getPlotCanvas() Gets the canvas used to render the CSV plot.
void	init(org.eclipse.ui.IEditorSite site, org.eclipse.ui.IEditorInput input)
boolean	isDirty()
boolean	isSaveAsAllowed()
void	refresh() This operation refreshes the VisIt view.
void	removeSeries(ISeries series) Removes the selected series from this editor.
void	setFocus()
void	showPlotProvider(PlotProvider displayPlotProvider) This function sets up the SWT XYGraph

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

getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setInitializationData

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

addPartPropertyListener, addPropertyListener, dispose, getAdapter, getContentDescription, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, showBusy

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, dispose, getSite, getTitle, getTitleImage, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

ID

public static final java.lang.String ID

The ID for this editor.

See Also:

Constant Field Values

Constructor Detail

CSVPlotEditor

public CSVPlotEditor()

The constructor

Method Detail

createPartControl

public void createPartControl(org.eclipse.swt.widgets.Composite parent)

This operation sets up the Composite that contains the VisIt canvas and create the VisIt widget.

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Specified by:

createPartControl in class org.eclipse.ui.part.WorkbenchPart

Parameters:

parent - The parent Composite to create the Control in.

doSave

public void doSave(org.eclipse.core.runtime.IProgressMonitor monitor)

Specified by:

doSave in interface org.eclipse.ui.ISaveablePart

Specified by:

doSave in class org.eclipse.ui.part.EditorPart

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface org.eclipse.ui.ISaveablePart

Specified by:

doSaveAs in class org.eclipse.ui.part.EditorPart

getPlotCanvas

public org.eclipse.swt.widgets.Canvas getPlotCanvas()

Gets the canvas used to render the CSV plot.

Returns:

The plot canvas.

init

public void init(org.eclipse.ui.IEditorSite site,
                 org.eclipse.ui.IEditorInput input)
          throws org.eclipse.ui.PartInitException

Specified by:

init in interface org.eclipse.ui.IEditorPart

Specified by:

init in class org.eclipse.ui.part.EditorPart

Throws:

org.eclipse.ui.PartInitException

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.ISaveablePart

Specified by:

isDirty in class org.eclipse.ui.part.EditorPart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface org.eclipse.ui.ISaveablePart

Specified by:

isSaveAsAllowed in class org.eclipse.ui.part.EditorPart

refresh

public void refresh()

This operation refreshes the VisIt view.

removeSeries

public void removeSeries(ISeries series)

Removes the selected series from this editor. Should remove if the series is

Parameters:

series -

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Specified by:

setFocus in class org.eclipse.ui.part.WorkbenchPart

showPlotProvider

public void showPlotProvider(PlotProvider displayPlotProvider)

This function sets up the SWT XYGraph

Parameters:

displayPlotProvider - The PlotProvider containing the information to create the plot