info.textgrid.lab.core.metadataeditor

Class MetaDataView

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.ui.part.WorkbenchPart

org.eclipse.ui.part.ViewPart

info.textgrid.lab.core.metadataeditor.MetaDataView

All Implemented Interfaces:

IMetadataPart, ITextGridProjectListener, TextGridObject.ITextGridObjectListener, EventListener, IAdaptable, IExecutableExtension, IPartListener, IPersistable, ISaveablePart, ISelectionListener, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPart3, IWorkbenchPartOrientation

public class MetaDataView
extends ViewPart
implements IMetadataPart, ISelectionListener, TextGridObject.ITextGridObjectListener, ITextGridProjectListener, ISaveablePart, IPartListener

This is the class to create the Metadata editor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetaDataView.OBJECT_TYPE

Nested classes/interfaces inherited from interface info.textgrid.lab.core.model.TextGridObject.ITextGridObjectListener

TextGridObject.ITextGridObjectListener.Event

Nested classes/interfaces inherited from interface info.textgrid.lab.core.model.ITextGridProjectListener

ITextGridProjectListener.Event

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Fields inherited from interface org.eclipse.ui.ISaveablePart

PROP_DIRTY

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

Constructors

Constructor and Description
MetaDataView()

Method Summary

Modifier and Type	Method and Description
static String	convertStreamToString(InputStream is)
void	createPartControl(Composite parent) This is a callback that will allow us to create the viewer and initialize it.
void	dispose()
void	doSave(IProgressMonitor monitor)
void	doSaveAs()
TextGridObject	getTextGridObject() Returns the at the moment loaded TextGrid object.
boolean	isDirty()
boolean	isEditable()
boolean	isSaveAsAllowed()
boolean	isSaveOnCloseNeeded()
void	partActivated(IWorkbenchPart part)
void	partBroughtToTop(IWorkbenchPart part)
void	partClosed(IWorkbenchPart part)
void	partDeactivated(IWorkbenchPart part)
void	partOpened(IWorkbenchPart part)
void	reloadProjectFile(TextGridProject project)
void	selectionChanged(IWorkbenchPart sourcepart, ISelection selection) This is a call-back method that will be called when a resource is selected.
void	setFocus() Passing the focus request to the viewer's control.
void	setMetadataInView(TextGridObject tgO, boolean rebuild) Sets the metadata of the referred TextGridObject in the view.
void	setVisible(boolean visible) Set the visibility of the content of the Metadata-Editor.
void	textGridObjectChanged(TextGridObject.ITextGridObjectListener.Event event, TextGridObject object) This method will be called on changes in the TextGridObject.
void	textGridProjectChanged(ITextGridProjectListener.Event event, TextGridProject project) The given event has happend to the given project.
void	triggerCheckField(String xpathQuery) Check the content of a field in the metadata editor using xpath-Query to select this field
void	update() Updates the metadata editor on changes.
boolean	validate() Validate the input of the meta data part

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

checkSite, getViewSite, init, init, saveState, setContentDescription, setInitializationData, setPartName

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

addPartPropertyListener, addPropertyListener, firePartPropertyChanged, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getPartProperties, getPartProperty, getSite, getTitle, getTitleImage, getTitleToolTip, 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.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

MetaDataView

public MetaDataView()

Method Detail

createPartControl

public void createPartControl(Composite parent)

This is a callback that will allow us to create the viewer and initialize it.

Specified by:

createPartControl in interface IWorkbenchPart

Specified by:

createPartControl in class WorkbenchPart

setVisible

public void setVisible(boolean visible)

Set the visibility of the content of the Metadata-Editor.

Parameters:

visible -

convertStreamToString

public static String convertStreamToString(InputStream is)
                                    throws Exception

Throws:

Exception

selectionChanged

public void selectionChanged(IWorkbenchPart sourcepart,
                             ISelection selection)

This is a call-back method that will be called when a resource is selected.

Specified by:

selectionChanged in interface ISelectionListener

setMetadataInView

public void setMetadataInView(TextGridObject tgO,
                              boolean rebuild)

Sets the metadata of the referred TextGridObject in the view.

Parameters:

tgO - the referred TextGridObject

setFocus

public void setFocus()

Passing the focus request to the viewer's control.

Specified by:

setFocus in interface IWorkbenchPart

Specified by:

setFocus in class WorkbenchPart

update

public void update()

Updates the metadata editor on changes.

Specified by:

update in interface IMetadataPart

dispose

public void dispose()

Specified by:

dispose in interface IWorkbenchPart

Overrides:

dispose in class WorkbenchPart

textGridProjectChanged

public void textGridProjectChanged(ITextGridProjectListener.Event event,
                                   TextGridProject project)

Description copied from interface: ITextGridProjectListener

The given event has happend to the given project.

Specified by:

textGridProjectChanged in interface ITextGridProjectListener

textGridObjectChanged

public void textGridObjectChanged(TextGridObject.ITextGridObjectListener.Event event,
                                  TextGridObject object)

This method will be called on changes in the TextGridObject.

Specified by:

textGridObjectChanged in interface TextGridObject.ITextGridObjectListener

doSave

public void doSave(IProgressMonitor monitor)

Specified by:

doSave in interface ISaveablePart

doSaveAs

public void doSaveAs()

Specified by:

doSaveAs in interface ISaveablePart

isDirty

public boolean isDirty()

Specified by:

isDirty in interface ISaveablePart

isSaveAsAllowed

public boolean isSaveAsAllowed()

Specified by:

isSaveAsAllowed in interface ISaveablePart

isSaveOnCloseNeeded

public boolean isSaveOnCloseNeeded()

Specified by:

isSaveOnCloseNeeded in interface ISaveablePart

validate

public boolean validate()

Description copied from interface: IMetadataPart

Validate the input of the meta data part

Specified by:

validate in interface IMetadataPart

Returns:

boolean

partActivated

public void partActivated(IWorkbenchPart part)

Specified by:

partActivated in interface IPartListener

partBroughtToTop

public void partBroughtToTop(IWorkbenchPart part)

Specified by:

partBroughtToTop in interface IPartListener

partClosed

public void partClosed(IWorkbenchPart part)

Specified by:

partClosed in interface IPartListener

partDeactivated

public void partDeactivated(IWorkbenchPart part)

Specified by:

partDeactivated in interface IPartListener

partOpened

public void partOpened(IWorkbenchPart part)

Specified by:

partOpened in interface IPartListener

isEditable

public boolean isEditable()

Specified by:

isEditable in interface IMetadataPart

getTextGridObject

public TextGridObject getTextGridObject()

Returns the at the moment loaded TextGrid object.

Returns:

TextGridObject

triggerCheckField

public void triggerCheckField(String xpathQuery)

Check the content of a field in the metadata editor using xpath-Query to select this field

Parameters:

xpathQuery - the xpathQuery which contains the path of the field

reloadProjectFile

public void reloadProjectFile(TextGridProject project)
                       throws CoreException

Throws:

CoreException