Package gda.rcp.views

Class Browser<T extends Document>

java.lang.Object

gda.rcp.views.Browser<T>

Type Parameters:

T - the type of objects displayed in the browser

Direct Known Subclasses:

ScanningAcquisitionBrowserBase

public abstract class Browser<T extends Document>
extends Object

Defines the information necessary to create a AcquisitionsBrowserCompositeFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Browser(AcquisitionConfigurationResourceType type)

Method Summary

Modifier and Type	Method	Description
abstract void	addColumns(TreeViewerBuilder<AcquisitionConfigurationResource<T>> builder)	Adds a column to the the TreeViewer contained in AcquisitionsBrowserCompositeFactory
List<AcquisitionConfigurationResource<T>>	getAcquisitionConfigurationResources(boolean reload)	Returns the browser objects
URL	getBrowserWorkingDir()	From where the browser loads its content
abstract org.eclipse.jface.viewers.ITreeContentProvider	getContentProvider()	Formats the objects in a suitable format for the TreeViewer contained in AcquisitionsBrowserCompositeFactory
abstract org.eclipse.jface.viewers.IDoubleClickListener	getDoubleClickListener()	An action executed when the user double click a row in the browser
abstract org.eclipse.jface.viewers.ISelectionChangedListener	getISelectionChangedListener(org.eclipse.jface.action.MenuManager contextMenu)	An action executed when a row in the browser is selected
protected AcquisitionConfigurationResource<T>	getSelected()
abstract TreeViewerBuilder<AcquisitionConfigurationResource<T>>	getTreeViewBuilder()	Generates the TreeViewerBuilder for the AcquisitionsBrowserCompositeFactory
AcquisitionConfigurationResourceType	getType()	The browser objects type
static final String	getURLLastPathSegment(AcquisitionConfigurationResource<?> element)	Extracts the last element from a AcquisitionConfigurationResource.getLocation().
protected void	setSelected(AcquisitionConfigurationResource<T> selected)

Methods inherited from class java.lang.Object

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

Constructor Details

Browser

protected Browser(AcquisitionConfigurationResourceType type)

Method Details

getAcquisitionConfigurationResources

public List<AcquisitionConfigurationResource<T>> getAcquisitionConfigurationResources(boolean reload)

Returns the browser objects

Parameters:

reload - if true reloads the object from getBrowserWorkingDir()

Returns:

the object displayed in the browser

getType

public AcquisitionConfigurationResourceType getType()

The browser objects type

Returns:

the browser type configuration

getBrowserWorkingDir

public URL getBrowserWorkingDir()

From where the browser loads its content

Returns:

a location

getURLLastPathSegment

public static final String getURLLastPathSegment(AcquisitionConfigurationResource<?> element)

Extracts the last element from a AcquisitionConfigurationResource.getLocation(). For example for

 file://localhost/c$/WINDOWS/clock.avi
 

returns

 clock.avi
 

Parameters:

element - the resource from where extract the string

Returns:

the URL last segment in the URL path

getContentProvider

public abstract org.eclipse.jface.viewers.ITreeContentProvider getContentProvider()

Formats the objects in a suitable format for the TreeViewer contained in AcquisitionsBrowserCompositeFactory

Returns:

a tree content provider

addColumns

public abstract void addColumns(TreeViewerBuilder<AcquisitionConfigurationResource<T>> builder)

Adds a column to the the TreeViewer contained in AcquisitionsBrowserCompositeFactory

Parameters:

builder -

getTreeViewBuilder

public abstract TreeViewerBuilder<AcquisitionConfigurationResource<T>> getTreeViewBuilder()

Generates the TreeViewerBuilder for the AcquisitionsBrowserCompositeFactory

Returns:

a builder

getISelectionChangedListener

public abstract org.eclipse.jface.viewers.ISelectionChangedListener getISelectionChangedListener(org.eclipse.jface.action.MenuManager contextMenu)

An action executed when a row in the browser is selected

Returns:

a selection listener

getDoubleClickListener

public abstract org.eclipse.jface.viewers.IDoubleClickListener getDoubleClickListener()

An action executed when the user double click a row in the browser

Returns:

a listener

setSelected

protected void setSelected(AcquisitionConfigurationResource<T> selected)

getSelected

protected AcquisitionConfigurationResource<T> getSelected()