org.eclipse.emf.emfstore.internal.client.ui.decorators

Class VersionDecorator

java.lang.Object

org.eclipse.emf.common.notify.impl.AdapterImpl

org.eclipse.emf.emfstore.internal.client.ui.decorators.VersionDecorator

All Implemented Interfaces:

org.eclipse.emf.common.notify.Adapter, org.eclipse.emf.common.notify.Adapter.Internal, ESCommitObserver, ESUpdateObserver, ESObserver, org.eclipse.jface.viewers.IBaseLabelProvider, org.eclipse.jface.viewers.ILightweightLabelDecorator

public class VersionDecorator
extends org.eclipse.emf.common.notify.impl.AdapterImpl
implements org.eclipse.jface.viewers.ILightweightLabelDecorator, ESUpdateObserver, ESCommitObserver

The decorator that shows the version of a ProjectSpace.

Author:

Helming

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.common.notify.Adapter

org.eclipse.emf.common.notify.Adapter.Internal

Constructor Summary

Constructors

Constructor and Description
VersionDecorator() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
void	commitCompleted(ESLocalProject project, ESPrimaryVersionSpec newRevision, org.eclipse.core.runtime.IProgressMonitor monitor) Called after the commit is completed.
void	decorate(Object element, org.eclipse.jface.viewers.IDecoration decoration) .
void	dispose()
boolean	inspectChanges(ESLocalProject project, ESChangePackage changePackage, org.eclipse.core.runtime.IProgressMonitor monitor) Called before the commit proceeds.
boolean	inspectChanges(ESLocalProject project, List<ESChangePackage> changePackages, org.eclipse.core.runtime.IProgressMonitor monitor) Called to notify the observer about the changes that will be merged into the project space.
boolean	isLabelProperty(Object element, String property) .
void	notifyChanged(org.eclipse.emf.common.notify.Notification msg)
void	removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)
void	updateCompleted(ESLocalProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Called after the changes have been applied to the project and the update is completed.

Methods inherited from class org.eclipse.emf.common.notify.impl.AdapterImpl

getTarget, isAdapterForType, setTarget, unsetTarget

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionDecorator

public VersionDecorator()

Default constructor.

Method Detail

decorate

public void decorate(Object element,
                     org.eclipse.jface.viewers.IDecoration decoration)

.

Specified by:

decorate in interface org.eclipse.jface.viewers.ILightweightLabelDecorator

addListener

public void addListener(org.eclipse.jface.viewers.ILabelProviderListener listener)

Specified by:

addListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

See Also:

IBaseLabelProvider.addListener(org.eclipse.jface.viewers.ILabelProviderListener)

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.jface.viewers.IBaseLabelProvider

See Also:

IBaseLabelProvider.dispose()

isLabelProperty

public boolean isLabelProperty(Object element,
                               String property)

.

Specified by:

isLabelProperty in interface org.eclipse.jface.viewers.IBaseLabelProvider

removeListener

public void removeListener(org.eclipse.jface.viewers.ILabelProviderListener listener)

Specified by:

removeListener in interface org.eclipse.jface.viewers.IBaseLabelProvider

See Also:

IBaseLabelProvider.removeListener(org.eclipse.jface.viewers.ILabelProviderListener)

notifyChanged

public void notifyChanged(org.eclipse.emf.common.notify.Notification msg)

Specified by:

notifyChanged in interface org.eclipse.emf.common.notify.Adapter

Overrides:

notifyChanged in class org.eclipse.emf.common.notify.impl.AdapterImpl

See Also:

AdapterImpl.notifyChanged(org.eclipse.emf.common.notify.Notification)

inspectChanges

public boolean inspectChanges(ESLocalProject project,
                              ESChangePackage changePackage,
                              org.eclipse.core.runtime.IProgressMonitor monitor)

Called before the commit proceeds. A callback method to initiate the commit dialog and allow the user to confirm the changes.

Specified by:

inspectChanges in interface ESCommitObserver

Parameters:

project - the project the commit occurs on

changePackage - the ESChangePackage

monitor - an IProgressMonitor instance that may be used by clients to inform about progress

Returns:

true if the changes have been confirmed, false - otherwise.

See Also:

ESCommitObserver.inspectChanges(org.eclipse.emf.emfstore.client.ESLocalProject, org.eclipse.emf.emfstore.server.model.ESChangePackage, org.eclipse.core.runtime.IProgressMonitor)

commitCompleted

public void commitCompleted(ESLocalProject project,
                            ESPrimaryVersionSpec newRevision,
                            org.eclipse.core.runtime.IProgressMonitor monitor)

Called after the commit is completed.

Specified by:

commitCompleted in interface ESCommitObserver

Parameters:

project - the project on which the commit has completed

newRevision - the new revision that was created by the commit

monitor - an IProgressMonitor instance that may be used by clients to inform about progress

See Also:

ESCommitObserver.commitCompleted(org.eclipse.emf.emfstore.client.ESLocalProject, org.eclipse.emf.emfstore.server.model.versionspec.ESPrimaryVersionSpec, org.eclipse.core.runtime.IProgressMonitor)

inspectChanges

public boolean inspectChanges(ESLocalProject project,
                              List<ESChangePackage> changePackages,
                              org.eclipse.core.runtime.IProgressMonitor monitor)

Called to notify the observer about the changes that will be merged into the project space.

Specified by:

inspectChanges in interface ESUpdateObserver

Parameters:

project - the ESLocalProject that should be updated

changePackages - a list of ESChangePackages containing the update changes

monitor - an IProgressMonitor instance that may be used by clients to inform about progress

Returns:

false if the observer wants to cancel the update, true otherwise

updateCompleted

public void updateCompleted(ESLocalProject project,
                            org.eclipse.core.runtime.IProgressMonitor monitor)

Called after the changes have been applied to the project and the update is completed.

Specified by:

updateCompleted in interface ESUpdateObserver

Parameters:

project - the ESLocalProject whose update has been completed

monitor - an IProgressMonitor instance that may be used by clients to inform about progress

See Also:

ESUpdateObserver.updateCompleted(org.eclipse.emf.emfstore.client.ESLocalProject, org.eclipse.core.runtime.IProgressMonitor)