org.eclipse.team.ui.synchronize
Interface ISynchronizeManager

public interface ISynchronizeManager

Manages synchronization view participants. Clients can programatically add or remove participants via this manager.

Clients are not intended to implement this interface.

Since:

3.0

See Also:

ISynchronizeParticipant

Method Summary

void	addSynchronizeParticipantListener(ISynchronizeParticipantListener listener) Registers the given listener for participant notifications.
void	addSynchronizeParticipants(ISynchronizeParticipant[] consoles) Adds the given participants to the synchronize manager.
ISynchronizeParticipant[]	find(String id) Returns the registered synchronize participants with the given id.
ISynchronizeParticipantDescriptor	getParticipantDescriptor(String id) Returns the participant descriptor for the given participant id or null if a descriptor is not found for that id.
ISynchronizeParticipant[]	getSynchronizeParticipants() Returns a collection of synchronize participants registered with the synchronize manager.
void	removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener) Deregisters the given listener for participant notifications.
void	removeSynchronizeParticipants(ISynchronizeParticipant[] consoles) Removes the given participants from the synchronize manager.
ISynchronizeView	showSynchronizeViewInActivePage(IWorkbenchPage page) Opens the synchronize view in the given page.

Method Detail

addSynchronizeParticipantListener

public void addSynchronizeParticipantListener(ISynchronizeParticipantListener listener)

Registers the given listener for participant notifications. Has no effect if an identical listener is already registered.

Parameters:

listener - listener to register

removeSynchronizeParticipantListener

public void removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener)

Deregisters the given listener for participant notifications. Has no effect if an identical listener is not already registered.

Parameters:

listener - listener to deregister

addSynchronizeParticipants

public void addSynchronizeParticipants(ISynchronizeParticipant[] consoles)

Adds the given participants to the synchronize manager. Has no effect for equivalent participants are already registered. The participants will be added to any existing synchronize views.

Parameters:

consoles - consoles to add

removeSynchronizeParticipants

public void removeSynchronizeParticipants(ISynchronizeParticipant[] consoles)

Removes the given participants from the synchronize manager. If the participants are being displayed in any synchronize views, the associated pages will be closed.

Parameters:

consoles - consoles to remove

getSynchronizeParticipants

public ISynchronizeParticipant[] getSynchronizeParticipants()

Returns a collection of synchronize participants registered with the synchronize manager.

Returns:

a collection of synchronize participants registered with the synchronize manager.

showSynchronizeViewInActivePage

public ISynchronizeView showSynchronizeViewInActivePage(IWorkbenchPage page)

Opens the synchronize view in the given page. Has no effect if the view is already open in that page.

Returns:

the opened synchronize view

find

public ISynchronizeParticipant[] find(String id)

Returns the registered synchronize participants with the given id. It is possible to have multiple instances of the same participant type.

Returns:

the registered synchronize participants with the given id, or null if none with that id is not registered.

getParticipantDescriptor

public ISynchronizeParticipantDescriptor getParticipantDescriptor(String id)

Returns the participant descriptor for the given participant id or null if a descriptor is not found for that id.

Returns:

the participant descriptor for the given participant id or null if a descriptor is not found for that id.