org.eclipse.eavp.viz.service.widgets

Class PlotDialogProvider

java.lang.Object

org.eclipse.eavp.viz.service.widgets.PlotDialogProvider

public class PlotDialogProvider
extends java.lang.Object

This class provides access to a dialog that can be used to create an IPlot from all available visualization services. This is extremely useful if more than one visualization service is capable of rendering a given file, as the user will need to make a selection.

Author:

Jordan Deyton

Constructor Summary

Constructors

Constructor and Description
PlotDialogProvider()

Method Summary

Modifier and Type	Method and Description
java.util.List<IPlot>	getAllPlots() Gets all plots that were created by the dialog.
IPlot	getSelectedPlot() Gets the plot created from the selected visualization service.
IVizService	getSelectedService() Gets the service used to create the plot.
int	openDialog(org.eclipse.swt.widgets.Shell shell, java.net.URI uri) If there are multiple visualization services available that can create plots for the specified file, this presents a dialog allowing the user to select the preferred service.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotDialogProvider

public PlotDialogProvider()

Method Detail

getAllPlots

public java.util.List<IPlot> getAllPlots()

Gets all plots that were created by the dialog. This includes the one for the selected viz service.

Returns:

A list containing all created plots.

getSelectedPlot

public IPlot getSelectedPlot()

Gets the plot created from the selected visualization service.

Returns:

The selected plot, or null if the dialog was cancelled or there was no viz service that could create a plot.

getSelectedService

public IVizService getSelectedService()

Gets the service used to create the plot.

Returns:

The IVizService which was chosen to create the plot.

openDialog

public int openDialog(org.eclipse.swt.widgets.Shell shell,
                      java.net.URI uri)

If there are multiple visualization services available that can create plots for the specified file, this presents a dialog allowing the user to select the preferred service.

Otherwise, a dialog is not presented if there is no viz service or only one available for the specified URI.

The plot created by the selected visualization service can be retrieved by calling getSelectedPlot().

Parameters:

shell - The parent shell on which to open the dialog.

uri - The URI of the file that needs a plot.

Returns:

The result of the dialog. If Window.OK, then at least one plot is available or was selected. Otherwise ( Window.CANCEL), no plot was selected.