com.gratex.perconik.activity.ide.listeners

Class IdeDocumentListener

java.lang.Object

sk.stuba.fiit.perconik.core.AbstractRegistrable

sk.stuba.fiit.perconik.core.Adapter

com.gratex.perconik.activity.ide.listeners.IdeListener

com.gratex.perconik.activity.ide.listeners.IdeDocumentListener

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.filebuffers.IFileBufferListener, org.eclipse.core.resources.IResourceChangeListener, org.eclipse.ui.ISelectionListener, FilteringListener<ResourceEventType>, Listener, EditorListener, FileBufferListener, ResourceListener, SelectionListener, Registrable

public final class IdeDocumentListener
extends IdeListener
implements EditorListener, FileBufferListener, ResourceListener, SelectionListener

A listener of IDE document events. This listener handles desired events and eventually builds corresponding data transfer objects of type IdeDocumentEventRequest and passes them to the IdeUacaProxy to be transferred into the User Activity Central Application for further processing.

Document operation types that this listener is interested in are determined by the IdeDocumentEventType enumeration:

• Add - a document is added into the project.
• Close - an opened document is closed.
• Open - a closed document is opened.
• Remove - a document is removed from the project.
• Rename - currently not supported.
• Save - a document is saved.
• Switch to - focus is changed from one document to another and editor selections (tabs and text). Note that structured selections in package explorer are supported.

Data available in an IdeDocumentEventRequest:

• document - see IdeDocumentDto below.
• See IdeListener for documentation of inherited data.

Data available in an IdeDocumentDto:

• branch - current Git branch name for the document.
• changesetIdInRcs - most recent Git commit identifier for the document (40 hexadecimal characters), for example "984dd5f359532d7d806a92b47ef5bfc39d772d64".
• localPath - path to the document relative to the workspace root, for example "com.gratex.perconik.activity/src/com/gratex/perconik/activity/ide/listeners/IdeCommitListener.java".
• rcsServer - see documentation of RcsServerDto in IdeCommitListener for more details.
• serverPath - always the same as localPath.

Note that in case of not editable source code, such as classes from JRE system library, fields branchName, changesetIdInRcs, and rcsServer are unused and set to null.

Since:

1.0

Author:

Pavol Zbell

Constructor Summary

Constructors

Constructor and Description
IdeDocumentListener()

Method Summary

Modifier and Type	Method and Description
void	bufferContentAboutToBeReplaced(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	bufferContentReplaced(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	bufferCreated(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	bufferDisposed(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	dirtyStateChanged(org.eclipse.core.filebuffers.IFileBuffer buffer, boolean dirty)
void	editorActivated(org.eclipse.ui.IEditorReference reference)
void	editorBroughtToTop(org.eclipse.ui.IEditorReference reference)
void	editorClosed(org.eclipse.ui.IEditorReference reference)
void	editorDeactivated(org.eclipse.ui.IEditorReference reference)
void	editorHidden(org.eclipse.ui.IEditorReference reference)
void	editorInputChanged(org.eclipse.ui.IEditorReference reference)
void	editorOpened(org.eclipse.ui.IEditorReference reference)
void	editorVisible(org.eclipse.ui.IEditorReference reference)
java.util.Set<ResourceEventType>	getEventTypes() Gets accepted event types.
void	postRegister() Post-register block.
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
void	selectionChanged(org.eclipse.ui.IWorkbenchPart part, org.eclipse.jface.viewers.ISelection selection)
void	stateChangeFailed(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	stateChanging(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	stateValidationChanged(org.eclipse.core.filebuffers.IFileBuffer buffer, boolean stateValidated)
void	underlyingFileDeleted(org.eclipse.core.filebuffers.IFileBuffer buffer)
void	underlyingFileMoved(org.eclipse.core.filebuffers.IFileBuffer buffer, org.eclipse.core.runtime.IPath path)

Methods inherited from class com.gratex.perconik.activity.ide.listeners.IdeListener

postUnregister, preRegister

Methods inherited from class sk.stuba.fiit.perconik.core.AbstractRegistrable

preUnregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface sk.stuba.fiit.perconik.core.Listener

equals

Methods inherited from interface sk.stuba.fiit.perconik.core.Registrable

postUnregister, preRegister, preUnregister

Constructor Detail

IdeDocumentListener

public IdeDocumentListener()

Method Detail

postRegister

public void postRegister()

Description copied from interface: Registrable

Post-register block. Called by the registration manager right after it internally registers this object.

Specified by:

postRegister in interface Registrable

Overrides:

postRegister in class AbstractRegistrable

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

selectionChanged

public void selectionChanged(org.eclipse.ui.IWorkbenchPart part,
                             org.eclipse.jface.viewers.ISelection selection)

Specified by:

selectionChanged in interface org.eclipse.ui.ISelectionListener

editorOpened

public void editorOpened(org.eclipse.ui.IEditorReference reference)

Specified by:

editorOpened in interface EditorListener

editorClosed

public void editorClosed(org.eclipse.ui.IEditorReference reference)

Specified by:

editorClosed in interface EditorListener

editorActivated

public void editorActivated(org.eclipse.ui.IEditorReference reference)

Specified by:

editorActivated in interface EditorListener

editorDeactivated

public void editorDeactivated(org.eclipse.ui.IEditorReference reference)

Specified by:

editorDeactivated in interface EditorListener

editorVisible

public void editorVisible(org.eclipse.ui.IEditorReference reference)

Specified by:

editorVisible in interface EditorListener

editorHidden

public void editorHidden(org.eclipse.ui.IEditorReference reference)

Specified by:

editorHidden in interface EditorListener

editorBroughtToTop

public void editorBroughtToTop(org.eclipse.ui.IEditorReference reference)

Specified by:

editorBroughtToTop in interface EditorListener

editorInputChanged

public void editorInputChanged(org.eclipse.ui.IEditorReference reference)

Specified by:

editorInputChanged in interface EditorListener

bufferCreated

public void bufferCreated(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

bufferCreated in interface org.eclipse.core.filebuffers.IFileBufferListener

bufferDisposed

public void bufferDisposed(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

bufferDisposed in interface org.eclipse.core.filebuffers.IFileBufferListener

bufferContentAboutToBeReplaced

public void bufferContentAboutToBeReplaced(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

bufferContentAboutToBeReplaced in interface org.eclipse.core.filebuffers.IFileBufferListener

bufferContentReplaced

public void bufferContentReplaced(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

bufferContentReplaced in interface org.eclipse.core.filebuffers.IFileBufferListener

stateChanging

public void stateChanging(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

stateChanging in interface org.eclipse.core.filebuffers.IFileBufferListener

stateChangeFailed

public void stateChangeFailed(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

stateChangeFailed in interface org.eclipse.core.filebuffers.IFileBufferListener

stateValidationChanged

public void stateValidationChanged(org.eclipse.core.filebuffers.IFileBuffer buffer,
                                   boolean stateValidated)

Specified by:

stateValidationChanged in interface org.eclipse.core.filebuffers.IFileBufferListener

dirtyStateChanged

public void dirtyStateChanged(org.eclipse.core.filebuffers.IFileBuffer buffer,
                              boolean dirty)

Specified by:

dirtyStateChanged in interface org.eclipse.core.filebuffers.IFileBufferListener

underlyingFileMoved

public void underlyingFileMoved(org.eclipse.core.filebuffers.IFileBuffer buffer,
                                org.eclipse.core.runtime.IPath path)

Specified by:

underlyingFileMoved in interface org.eclipse.core.filebuffers.IFileBufferListener

underlyingFileDeleted

public void underlyingFileDeleted(org.eclipse.core.filebuffers.IFileBuffer buffer)

Specified by:

underlyingFileDeleted in interface org.eclipse.core.filebuffers.IFileBufferListener

getEventTypes

public java.util.Set<ResourceEventType> getEventTypes()

Description copied from interface: FilteringListener

Gets accepted event types.

Specified by:

getEventTypes in interface FilteringListener<ResourceEventType>

Returns:

accepted event types