info.textgrid.lab.collatex.ui.parts

Class CollationSetEditor

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.EditorPart

info.textgrid.lab.collatex.ui.parts.CollationSetEditor

All Implemented Interfaces:

EventListener, IResourceChangeListener, IAdaptable, IExecutableExtension, IEditorPart, IReusableEditor, ISaveablePart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class CollationSetEditor
extends EditorPart
implements IReusableEditor, IResourceChangeListener

Editor for a collation set. The active CollationSetEditor also determines which result pages will be shown, and the editor manages not only the CollationSet, but also the CollationResults.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollationSetEditor.ICollationEventHandler Event listener that is notified when a collation run has finished for this editor and thus new CollationResults object is available.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
protected boolean	readOnly

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
CollationSetEditor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addCollationListener(CollationSetEditor.ICollationEventHandler listener)
void	collate() Triggers the actual collation (after some optional confirmations by the user)
void	createPartControl(Composite parent) Create contents of the editor part.
void	createRegularisationSet() Helper method that creates a new normalization and associates it with the CollationSet in this editor.
void	deleteSelection() Deletes all currently selected witnesses.
void	doSave(IProgressMonitor monitor)
void	doSaveAs() Not yet implemented.
CollationResults	getCollationResults()
CollationSet	getCollationSet()
protected CheckboxTreeViewer	getCollationSetViewer()
protected info.textgrid.lab.core.model.TextGridObject	getInputObject()
CollationSetWitness[]	getSelectedWitnesses()
void	init(IEditorSite site, IEditorInput input) Loading happens in the background!
boolean	isDirty()
boolean	isSaveAsAllowed()
void	removeCollationListener(CollationSetEditor.ICollationEventHandler listener)
void	resourceChanged(IResourceChangeEvent event)
protected void	setCollationResults(CollationResults collationResults) Called after the CollateJob is done.
void	setDirty(boolean dirty)
void	setFocus()
void	setInput(IEditorInput input) Causes the given input to be loaded in the background.

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

checkSite, getEditorInput, getEditorSite, getTitleToolTip, isSaveOnCloseNeeded, setContentDescription, setInitializationData, setInputWithNotify, setPartName

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

addPartPropertyListener, addPropertyListener, dispose, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, removePartPropertyListener, removePropertyListener, setPartProperty, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IEditorPart

getEditorInput, getEditorSite

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

Methods inherited from interface org.eclipse.ui.ISaveablePart

isSaveOnCloseNeeded

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

readOnly

protected boolean readOnly

Constructor Detail

CollationSetEditor

public CollationSetEditor()

Method Detail

addCollationListener

public void addCollationListener(CollationSetEditor.ICollationEventHandler listener)

removeCollationListener

public void removeCollationListener(CollationSetEditor.ICollationEventHandler listener)

getCollationSet

public CollationSet getCollationSet()

getCollationResults

public CollationResults getCollationResults()

setCollationResults

protected void setCollationResults(CollationResults collationResults)

Called after the CollateJob is done. May be called from outside of the UI thread.

createPartControl

public void createPartControl(Composite parent)

Create contents of the editor part.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

Parameters:

parent -

createRegularisationSet

public void createRegularisationSet()

Helper method that creates a new normalization and associates it with the CollationSet in this editor. Note that this immediately requests an URI.

setFocus

public void setFocus()

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

doSave

public void doSave(IProgressMonitor monitor)

Specified by:

doSave in interface ISaveablePart

Specified by:

doSave in class EditorPart

doSaveAs

public void doSaveAs()

Not yet implemented.

Specified by:

doSaveAs in interface ISaveablePart

Specified by:

doSaveAs in class EditorPart

See Also:

EditorPart.doSaveAs()

init

public void init(IEditorSite site,
        IEditorInput input)
          throws PartInitException

Loading happens in the background!

Specified by:

init in interface IEditorPart

Specified by:

init in class EditorPart

Throws:

PartInitException

See Also:

EditorPart.init(org.eclipse.ui.IEditorSite, org.eclipse.ui.IEditorInput), setInput(IEditorInput)

setInput

public void setInput(IEditorInput input)

Causes the given input to be loaded in the background. Fires an appropriate notification when the input has been completely loaded.

Specified by:

setInput in interface IReusableEditor

Overrides:

setInput in class EditorPart

See Also:

EditorPart.setInput(org.eclipse.ui.IEditorInput)

getInputObject

protected info.textgrid.lab.core.model.TextGridObject getInputObject()

isDirty

public boolean isDirty()

Specified by:

isDirty in interface ISaveablePart

Specified by:

isDirty in class EditorPart

setDirty

public void setDirty(boolean dirty)

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface ISaveablePart

Specified by:

isSaveAsAllowed in class EditorPart

getCollationSetViewer

protected CheckboxTreeViewer getCollationSetViewer()

collate

public void collate()

Triggers the actual collation (after some optional confirmations by the user)

getSelectedWitnesses

public CollationSetWitness[] getSelectedWitnesses()

deleteSelection

public void deleteSelection()

Deletes all currently selected witnesses.

resourceChanged

public void resourceChanged(IResourceChangeEvent event)

Specified by:

resourceChanged in interface IResourceChangeListener