org.eclipse.eavp.viz.visit

Class VisitPlotViewer

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.ViewPart

org.eclipse.eavp.viz.visit.VisitPlotViewer

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.core.runtime.IExecutableExtension, IVizUpdateableListener, IDeletePlotActionViewPart, org.eclipse.jface.viewers.IDoubleClickListener, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.ui.IPersistable, org.eclipse.ui.IViewPart, org.eclipse.ui.IWorkbenchPart, org.eclipse.ui.IWorkbenchPart2, org.eclipse.ui.IWorkbenchPart3, org.eclipse.ui.part.IWorkbenchPartOrientation

public class VisitPlotViewer
extends org.eclipse.ui.part.ViewPart
implements IDeletePlotActionViewPart, IVizUpdateableListener, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.jface.viewers.IDoubleClickListener

This class extends the ViewPart class and provides a view in the Visualization Perspective to look at the plots that are currently available.

Author:

Jay Jay Billings, Taylor Patterson, Jordan H. Deyton

Field Summary

Fields

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

Fields inherited from interface org.eclipse.eavp.viz.datastructures.VizObject.IVizUpdateableListener

component

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
VisitPlotViewer() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addPlot(VizEntry entry) Adds a plot to the current set of VisIt plots.
void	createPartControl(org.eclipse.swt.widgets.Composite parent) Creates the widgets and controls for the PlotViewer.
void	doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event) This method is used to draw plots whenever a TreeItem in the plotTreeViewer is double-clicked.
void	drawPlot(VizEntry entry) This method draws the plot for the specified entry if it is one of the selected plots.
void	drawSelection(org.eclipse.jface.viewers.IStructuredSelection selection) Draws all plots selected in plotTreeViewer.
IResource	getResource() Gets the current VisIt-compatible ICEResource that is being used by this PlotViewer.
VizResourceComponent	getResourceComponent() This operation retrieves the active ResourceComponent of this view or null if the component does not exist.
void	removePlot(VizEntry entry) Removes a plot from the current set of VisIt plots.
void	removeSelection() Removes all plots selected in plotTreeViewer.
void	selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event) This method is used to draw plots whenever a TreeItem in the plotTreeViewer is selected.
void	setEntryMap() This method fills in the entryMap based on the current resource.
void	setFocus() Does nothing yet.
void	setResource(IVizResource inResource) This method is called when the selection in the VizFileViewer has changed.
void	setResourceComponent(VizResourceComponent component) This operation sets the ResourceComponent that should be used by this view.
void	update(IVizUpdateable component) Updates the PlotViewer (specifically, the plotTreeViewer) when the associated Component is updated.

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

getViewSite, init, init, saveState, setInitializationData

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

addPartPropertyListener, addPropertyListener, dispose, getAdapter, getContentDescription, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, 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, getTitleToolTip, 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 view

See Also:

Constant Field Values

Constructor Detail

VisitPlotViewer

public VisitPlotViewer()

The default constructor.

Method Detail

createPartControl

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

Creates the widgets and controls for the PlotViewer. This includes plotTreeViewer.

Specified by:

createPartControl in interface org.eclipse.ui.IWorkbenchPart

Specified by:

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

Parameters:

parent - The parent Composite that will contain this PlotViewer.

See Also:

WorkbenchPart.createPartControl(Composite)

setFocus

public void setFocus()

Does nothing yet.

Specified by:

setFocus in interface org.eclipse.ui.IWorkbenchPart

Specified by:

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

See Also:

WorkbenchPart.setFocus()

update

public void update(IVizUpdateable component)

Updates the PlotViewer (specifically, the plotTreeViewer) when the associated Component is updated.

Specified by:

update in interface IVizUpdateableListener

Parameters:

component - The Component that was just updated.

setResourceComponent

public void setResourceComponent(VizResourceComponent component)

This operation sets the ResourceComponent that should be used by this view. It also registers this view with the ResourceComponent so that it can be notified of state changes through the IUpdateableListener interface.

Parameters:

component - The ResourceComponent

getResourceComponent

public VizResourceComponent getResourceComponent()

This operation retrieves the active ResourceComponent of this view or null if the component does not exist.

Returns:

The ResourceComponent or null if the component was not previously set.

getResource

public IResource getResource()

Gets the current VisIt-compatible ICEResource that is being used by this PlotViewer.

Returns:

an ICEResource with plots as the Entry properties.

addPlot

public void addPlot(VizEntry entry)

Adds a plot to the current set of VisIt plots. The entry should be a property of the current file's ICEResource.

Parameters:

entry - The Entry for the plot that is to be added.

removePlot

public void removePlot(VizEntry entry)

Removes a plot from the current set of VisIt plots. The entry should be a property of the current file's ICEResource.

Parameters:

entry - The Entry for the plot that is to be removed.

drawPlot

public void drawPlot(VizEntry entry)

This method draws the plot for the specified entry if it is one of the selected plots.

Parameters:

entry - The entry to draw with the VisIt widget.

removeSelection

public void removeSelection()

Removes all plots selected in plotTreeViewer.

Specified by:

removeSelection in interface IDeletePlotActionViewPart

drawSelection

public void drawSelection(org.eclipse.jface.viewers.IStructuredSelection selection)

Draws all plots selected in plotTreeViewer.

setEntryMap

public void setEntryMap()

This method fills in the entryMap based on the current resource.

setResource

public void setResource(IVizResource inResource)

This method is called when the selection in the VizFileViewer has changed. It is used to listen for changes to the currently selected VizResource in the VizFileViewer.

Parameters:

inResource - The VizResource in the VizFileViewer to set this object's resource to.

selectionChanged

public void selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

This method is used to draw plots whenever a TreeItem in the plotTreeViewer is selected. If multi-select is enabled, it draws all of the selected plots.

Specified by:

selectionChanged in interface org.eclipse.jface.viewers.ISelectionChangedListener

Parameters:

event - The SelectionChangedEvent that fired this method.

doubleClick

public void doubleClick(org.eclipse.jface.viewers.DoubleClickEvent event)

This method is used to draw plots whenever a TreeItem in the plotTreeViewer is double-clicked. If multi-select is enabled, it draws all of the selected plots.

Specified by:

doubleClick in interface org.eclipse.jface.viewers.IDoubleClickListener

Parameters:

event - The DoubleClickEvent that fired this method.