org.eclipse.eavp.viz.service.widgets

Class PlotGridComposite

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.eavp.viz.service.widgets.PlotGridComposite

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class PlotGridComposite
extends org.eclipse.swt.widgets.Composite

This custom composite is designed to display a grid of plots. It includes widgets to customize the grid-based layout of the plots. The order of a plot in the grid is based on the order in which it is created. The same plot cannot be added to the grid more than once.

Author:

Jordan Deyton

Field Summary

Fields inherited from class org.eclipse.swt.widgets.Control

view

Constructor Summary

Constructors

Constructor and Description
PlotGridComposite(org.eclipse.swt.widgets.Composite parent, int style) The default constructor.

Method Summary

Modifier and Type	Method and Description
int	addPlot(java.net.URI uri) Adds a plot to be drawn inside the plot grid.
boolean	contains(java.net.URI uri) Return true if the given URI has already been plotted and thus is contained in this PlotGridComposite.
void	dispose()
void	refreshPlots(java.net.URI uri) Refreshes any plots that may be associated with the specified URI.
int	removeAllPlots() Removes all plots from the grid.
boolean	removePlot(int index) Removes the plot with the specified index.
int	removePlots(java.net.URI uri) Removes any plot for the associated URI.
void	setBackground(org.eclipse.swt.graphics.Color color)

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlotGridComposite

public PlotGridComposite(org.eclipse.swt.widgets.Composite parent,
                         int style)

The default constructor. Creates a composite in the specified parent and with the specified style.

Parameters:

parent - a widget which will be the parent of the new instance (cannot be null)

style - the style of widget to construct

Method Detail

addPlot

public int addPlot(java.net.URI uri)

Adds a plot to be drawn inside the plot grid. Note that the same URI can be added more than once.

Parameters:

uri - The URI of the file to be opened as a plot in the grid.

Returns:

The index of the plot in the grid, or -1 if the plot could not be drawn.

Throws:

java.lang.Exception - An exception is thrown if the IPlot implementation cannot be rendered.

dispose

public void dispose()

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

refreshPlots

public void refreshPlots(java.net.URI uri)

Refreshes any plots that may be associated with the specified URI.

Parameters:

uri - The data file.

removeAllPlots

public int removeAllPlots()

Removes all plots from the grid.

Returns:

The number of removed plots.

removePlot

public boolean removePlot(int index)

Removes the plot with the specified index.

Parameters:

index - The index of the plot to remove.

Returns:

True if a plot was removed, false otherwise (if the index was invalid).

removePlots

public int removePlots(java.net.URI uri)

Removes any plot for the associated URI.

Parameters:

uri - The URI for which all plots will be removed.

Returns:

The number of plots removed.

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

Overrides:

setBackground in class org.eclipse.swt.widgets.Control

contains

public boolean contains(java.net.URI uri)

Return true if the given URI has already been plotted and thus is contained in this PlotGridComposite.

Parameters:

uri -

Returns: