Eclipse Platform
Release 3.1

Package org.eclipse.team.ui.synchronize

Contains the team synchronization presentation framework and support for the Synchronize View.

See:
          Description

Interface Summary
ISynchronizeManager Manages synchronization view participants.
ISynchronizeModelChangeListener Listener that gets informed when the model created by the model provider is created or updated.
ISynchronizeModelElement These are elements created to display synchronization state to the user.
ISynchronizePage Interface for Page subclasses that can appear in the synchronize view ISynchronizeView and other views, editors or dialogs that display synchronization information.
ISynchronizePageConfiguration Configures the model, actions and label decorations of an ISynchronizePage.
ISynchronizePageSite A site which provides access to the context in which this page is being displayed.
ISynchronizeParticipant A synchronize participant is a visual component that can be displayed within any control (e.g. view, editor, dialog).
ISynchronizeParticipantDescriptor A participant descriptor contains the content of the synchronizeParticipants extension section for for a registered participant type in the declaring plug-in's manifest (plugin.xml) file.
ISynchronizeParticipantListener A synchronize participant listener is notified when participants are added or removed from the synchronize manager.
ISynchronizeParticipantReference A reference is a light weight handle used by the ISynchronizeManager to manage registered participants.
ISynchronizeScope A synchronize scope defines the set of resources involved in a synchronization.
ISynchronizeView A view that displays synchronization participants that are registered with the synchronize manager.
 

Class Summary
AbstractSynchronizeParticipant This class is the abstract base class for all synchronize view participants.
AbstractSynchronizeScope Abstract superclass of resource scopes for SubscriberParticipant instances.
ParticipantPageDialog A dialog that displays the option of adding the participant to the ISynchronizeManager when the dialog is closed.
ParticipantPagePane Standalone presentation of a participant page within a view pane.
ParticipantPageSaveablePart Displays a synchronize participant page combined with the compare/merge infrastructure.
ResourceScope A synchronize scope whose roots are a set of resources.
SubscriberParticipant A synchronize participant that displays synchronization information for local resources that are managed via a Subscriber.
SynchronizeModelAction This action provides utilities for performing operations on selections that contain ISynchronizeModelElement instances.
SynchronizeModelOperation A specialized team operation that operates on ISynchronizeModelElementelements.
SynchronizePageActionGroup Used to add one or more actions to the context menu, toolbar or view menu of an ISynchronizePage.
SyncInfoCompareInput A SyncInfo editor input used as input to a two-way or three-way compare viewer.
WorkingSetScope A synchronize scope whose roots are defined by a working set.
WorkspaceScope A synchronize scope whose roots are the workspace.
 

Package org.eclipse.team.ui.synchronize Description

Contains the team synchronization presentation framework and support for the Synchronize View.

Package Specification

Contains the team synchronization presentation framework and support for the Synchronize View. A synchronization framework is a unified architecture for presenting and manipulating resource synchronization state. Consider the synchronization model described by the classes in org.eclipse.team.core.synchronize as the physical representation of synchronization state then the classes in this package allow you to control how the model is presented to the user. This framework doesn't attempt to provide common operations for manipulating synchronization state. Instead it is left up to the framework user to add their own domain specific operations to the presentation.

The primary advantages of this synchronization presentation framework are that it:

The synchronization presentation framework consists of:


Synchronize View Interfaces

These interfaces and classes support a generic Synchronize View that can show multiple synchronize participants. The basic model for integrating into the Synchronize View consists of:

Synchronize participants are declared by extending the synchronizeParticipants extension point. A synchronize manager manages all active synchronize participants, and provides notification of participants which are added and removed. Participants are displayed in a page book view. Each participant implementation is reponsible for creating its page, which provides freedom of presentation to the synchronize view implementation. A single participant may be displayed simultaneously in multiple synchronize views, and in different workbench windows.


SubscriberParticipants

 SubscriberParticipant is an abstract class that is intented to support a common synchronization workflow. It is the easy way to get into the Synchronize View and essentially inherit the default synchronize experience. The requirement for using a SubscriberParticipant is to create a subscriber that can produce SyncInfo (e.g. objects that describe the synchronization between local and remote resources).

Compare Inputs

These are helpers for allowing users to display and edit resources being synchronized by integrating with the compare support available in Eclipse.

Synchronize action and operation utilities

These are helpers for writing actions that are performed on elements shown in synchronize viewers.

Related Documentation


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.