|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.runtime.PlatformObject
org.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant
org.eclipse.team.ui.synchronize.SubscriberParticipant
public abstract class SubscriberParticipant
A synchronize participant that displays synchronization information for local resources that are
managed via a Subscriber. It maintains a dynamic collection of all out-of-sync resources
by listening to workspace resource changes and remote changes thus creating a live view of
changes in the workspace.
The subscriber can be configured to be synchronized in the background based on a schedule. This effectively refreshes the subscriber and updates the dynamic sync set.
Subclasses will typically want to override the following methods:
| Field Summary |
|---|
| Fields inherited from class org.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant |
|---|
configElement, P_PINNED, P_SCHEDULED |
| Fields inherited from interface org.eclipse.team.ui.synchronize.ISynchronizeParticipant |
|---|
P_CONTENT |
| Constructor Summary | |
|---|---|
SubscriberParticipant()
Constructor initializes the schedule. |
|
SubscriberParticipant(ISynchronizeScope scope)
Constructor which should be called when creating a participant whose resources are to be scoped. |
|
| Method Summary | |
|---|---|
IPageBookViewPage |
createPage(ISynchronizePageConfiguration configuration)
Creates and returns a new page for this synchronize participant. |
void |
dispose()
Disposes of this synchronize participant and is called to free the resources associated with a participant. |
java.lang.Object |
getAdapter(java.lang.Class adapter)
Returns an object which is an instance of the given class associated with this object. |
protected java.lang.String |
getLongTaskName()
Deprecated. use getLongTaskName(IResource[]) instead |
protected java.lang.String |
getLongTaskName(IResource[] resources)
Returns the long task name to describe the behavior of the refresh operation to the user. |
static SubscriberParticipant |
getMatchingParticipant(java.lang.String ID,
IResource[] resources)
Returns a participant that matches the given resource scoping |
java.lang.String |
getName()
Returns the name of this synchronize participant. |
org.eclipse.team.internal.ui.synchronize.SubscriberRefreshSchedule |
getRefreshSchedule()
|
IResource[] |
getResources()
Returns the resources supervised by this participant. |
ISynchronizeScope |
getScope()
Return the scope that defines the resources displayed by this participant. |
protected java.lang.String |
getShortName()
Return the name of the participant as specified in the plugin manifest file. |
protected java.lang.String |
getShortTaskName()
Returns the short task name (e.g. no more than 25 characters) to describe the behavior of the refresh operation to the user. |
Subscriber |
getSubscriber()
Return the Subscriber associated with this this participant. |
org.eclipse.team.internal.core.subscribers.SubscriberSyncInfoCollector |
getSubscriberSyncInfoCollector()
Return the SubscriberSyncInfoCollector for the participant. |
SyncInfoTree |
getSyncInfoSet()
Returns the SyncInfoTree for this participant. |
void |
init(java.lang.String secondaryId,
IMemento memento)
Classes that are persisted must override this method and perform the following initialization. |
protected void |
initializeConfiguration(ISynchronizePageConfiguration configuration)
This method is invoked after a page configuration is created but before it is returned by the createPageConfiguration method. |
void |
propertyChange(PropertyChangeEvent event)
Notification that a property has changed. |
void |
refresh(IResource[] resources,
java.lang.String shortTaskName,
java.lang.String longTaskName,
IWorkbenchSite site)
Refresh a participant in the background the result of the refresh are shown in the progress view. |
void |
refreshInDialog(Shell shell,
IResource[] resources,
java.lang.String jobName,
java.lang.String taskName,
ISynchronizePageConfiguration configuration,
IWorkbenchSite site)
Refresh this participants synchronization state and displays the result in a model dialog. |
IStatus |
refreshNow(IResource[] resources,
java.lang.String taskName,
IProgressMonitor monitor)
Refresh a participant. |
void |
reset()
Reset the sync set of the participant by repopulating it from scratch. |
void |
run(IWorkbenchPart part)
Runs the participants action. |
void |
saveState(IMemento memento)
Saves the participants object state within the memento. |
void |
setRefreshSchedule(org.eclipse.team.internal.ui.synchronize.SubscriberRefreshSchedule schedule)
|
protected void |
setSubscriber(Subscriber subscriber)
Subclasses must call this method to initialize the participant. |
protected void |
setSyncInfoFilter(SyncInfoFilter filter)
Provide a filter that is used to filter the contents of the sync info set for the participant. |
protected void |
validateConfiguration(ISynchronizePageConfiguration configuration)
This method is invoked before the given configuration is used to create the page (see createPage(ISynchronizePageConfiguration)). |
| Methods inherited from class org.eclipse.team.ui.synchronize.AbstractSynchronizeParticipant |
|---|
addPropertyChangeListener, createPageConfiguration, doesSupportSynchronize, equals, firePropertyChange, getHelpContextId, getId, getImageDescriptor, getPreferencePages, getSecondaryId, hashCode, isPinned, isViewerContributionsSupported, pinned, prepareCompareInput, removePropertyChangeListener, setImageDescriptor, setInitializationData, setInitializationData, setName, setPinned, setSecondaryId |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SubscriberParticipant()
public SubscriberParticipant(ISynchronizeScope scope)
scope - a synchronize scope| Method Detail |
|---|
public final IPageBookViewPage createPage(ISynchronizePageConfiguration configuration)
ISynchronizeParticipantISynchronizePageSite.
createPage in interface ISynchronizeParticipantconfiguration - used to initialize the page
public IResource[] getResources()
public final void refreshInDialog(Shell shell,
IResource[] resources,
java.lang.String jobName,
java.lang.String taskName,
ISynchronizePageConfiguration configuration,
IWorkbenchSite site)
shell - resources - jobName - taskName - configuration - site -
public final void refresh(IResource[] resources,
java.lang.String shortTaskName,
java.lang.String longTaskName,
IWorkbenchSite site)
shortTaskName and longTaskName can be null
in which case, the default values for these are returned by the methods getShortTaskName() and
getLongTaskName(IResource[]) will be used.
resources - the resources to be refreshed.shortTaskName - the taskName of the background job that will run the synchronize or null
if the default job name is desired.longTaskName - the taskName of the progress monitor running the synchronize or null
if the default job name is desired.site - the workbench site the synchronize is running from. This can be used to notify the site
that a job is running.
public final IStatus refreshNow(IResource[] resources,
java.lang.String taskName,
IProgressMonitor monitor)
resources - taskName - monitor -
public void dispose()
ISynchronizeParticipantISynchronizeManager this method is called when the
manager is shutdown or the participant is removed from the manager.
Within this method a participant may release any resources, fonts, images, etc. held by this part. It is also very important to remove all listeners.
Clients should not call this method (the synchronize manager calls this method at appropriate times).
dispose in interface ISynchronizeParticipantpublic java.lang.String getName()
ISynchronizeParticipant
getName in interface ISynchronizeParticipantgetName in class AbstractSynchronizeParticipantprotected final java.lang.String getShortName()
getName() method defined in this class.
public SyncInfoTree getSyncInfoSet()
SyncInfoTree for this participant. This set
contains the out-of-sync resources supervised by this participant.
public Subscriber getSubscriber()
Subscriber associated with this this participant. This
method will only return null if the participant has not been initialized
yet.
Subscriber associated with this this participant.
public static SubscriberParticipant getMatchingParticipant(java.lang.String ID,
IResource[] resources)
ID - the type id of participants to matchresources - the resources to match in the scope
public void propertyChange(PropertyChangeEvent event)
IPropertyChangeListenerThis method gets called when the observed object fires a property change event.
propertyChange in interface IPropertyChangeListenerevent - the property change event object describing which property
changed and how
public void init(java.lang.String secondaryId,
IMemento memento)
throws PartInitException
AbstractSynchronizeParticipant
super.init(secondaryId, memento);
try {
ISynchronizeParticipantDescriptor descriptor = TeamUI.getSynchronizeManager().getParticipantDescriptor(PARTICIPANT_ID);
setInitializationData(descriptor);
} catch (CoreException e) {
TeamUIPlugin.log(e);
}
where PARTICIPANT_ID is the id of the participant as defined in the plugin manifest.
init in interface ISynchronizeParticipantinit in class AbstractSynchronizeParticipantsecondaryId - the secondayId of this participant instance or null
if this participant doesn't support multiple instances.memento - the participant state or null if there
is no previous saved state
PartInitException - if this participant was not initialized
successfullyISynchronizeParticipant.init(String, org.eclipse.ui.IMemento)public void saveState(IMemento memento)
ISynchronizeParticipantinit.
This method can be called multiple times during the lifetime of the participant object.
saveState in interface ISynchronizeParticipantsaveState in class AbstractSynchronizeParticipantmemento - a memento to receive the object statepublic void reset()
public org.eclipse.team.internal.core.subscribers.SubscriberSyncInfoCollector getSubscriberSyncInfoCollector()
SubscriberSyncInfoCollector for the participant.
This collector maintains the set of all out-of-sync resources for the
subscriber.
SubscriberSyncInfoCollector for this participantpublic void setRefreshSchedule(org.eclipse.team.internal.ui.synchronize.SubscriberRefreshSchedule schedule)
public org.eclipse.team.internal.ui.synchronize.SubscriberRefreshSchedule getRefreshSchedule()
protected void initializeConfiguration(ISynchronizePageConfiguration configuration)
AbstractSynchronizeParticipantcreatePageConfiguration method. Subclasses can implement this method to
tailor the configuration in ways appropriate to the participant.
initializeConfiguration in class AbstractSynchronizeParticipantconfiguration - the newly create page configurationpublic void run(IWorkbenchPart part)
ISynchronizeParticipant
run in interface ISynchronizeParticipantpart - the part in which the action is run or null if the action
is not being run in a workbench part.protected java.lang.String getShortTaskName()
protected java.lang.String getLongTaskName()
getLongTaskName(IResource[]) instead
protected java.lang.String getLongTaskName(IResource[] resources)
resources -
protected void validateConfiguration(ISynchronizePageConfiguration configuration)
createPage(ISynchronizePageConfiguration)).
The configuration would have been initialized by
initializeConfiguration(ISynchronizePageConfiguration)
but may have also been tailored further. This method gives the participant
a chance to validate those changes before the page is created.
configuration - the page configuration that is about to be used to create a page.protected void setSubscriber(Subscriber subscriber)
init(String, IMemento). This method will initialize
the sync info collector.
subscriber - the subscriber to associate with this participant.protected void setSyncInfoFilter(SyncInfoFilter filter)
Subclasses can invoke this method any time after setSubscriber has been invoked.
filter - a sync info filterpublic ISynchronizeScope getScope()
public java.lang.Object getAdapter(java.lang.Class adapter)
PlatformObjectnull if
no such object can be found.
This implementation of the method declared by IAdaptable
passes the request along to the platform's adapter manager; roughly
Platform.getAdapterManager().getAdapter(this, adapter).
Subclasses may override this method (however, if they do so, they
should invoke the method on their superclass to ensure that the
Platform's adapter manager is consulted).
getAdapter in interface IAdaptablegetAdapter in class PlatformObjectadapter - the class to adapt to
nullIAdaptable.getAdapter(Class)
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.