|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Manages synchronization view participants. Clients can programmatically add or remove participant instances from this manager. Managed participants are available to clients whereas un-managed participants can still exist but won't be available generally available to clients until explicitly added to the manager.
Participants added to the manager will benefit from the manager's lifecycle
support. The participants will automatically have their init
method and dispose
called when the manager starts and is shutdown and if persistable will
be allowed to save their state on shutdown.
Clients are not intended to implement this interface.
ISynchronizeParticipant
,
TeamUI.getSynchronizeManager()
Field Summary | |
---|---|
static Object |
FAMILY_SYNCHRONIZE_OPERATION
Constant identifying the job family identifier for a background job that affects the synchronization state of resources. |
Method Summary | |
---|---|
void |
addSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
Registers the given listener for participant notifications. |
void |
addSynchronizeParticipants(ISynchronizeParticipant[] participants)
Adds the given participants to the synchronize manager. |
ISynchronizeParticipantReference[] |
get(String id)
Returns the registered synchronize participants with the given type id. |
ISynchronizeParticipantReference |
get(String id,
String secondaryId)
Returns the registered synchronize participants with the given type id and instance id. |
ISynchronizeParticipantDescriptor |
getParticipantDescriptor(String type)
Returns the participant descriptor for the given participant type id or null if a descriptor is not found for that id. |
ISynchronizeParticipantReference[] |
getSynchronizeParticipants()
Returns a collection of synchronize participant references registered with the synchronize manager. |
void |
removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
Removes the given listener for participant notifications. |
void |
removeSynchronizeParticipants(ISynchronizeParticipant[] participants)
Removes the given participants from the synchronize manager. |
ISynchronizeView |
showSynchronizeViewInActivePage()
Opens the synchronize view in the perspective defined by the user in the team synchronize preferences. |
Field Detail |
public static final Object FAMILY_SYNCHRONIZE_OPERATION
belongsTo
.
Job.belongsTo(java.lang.Object)
Method Detail |
public void addSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
listener
- listener to registerpublic void removeSynchronizeParticipantListener(ISynchronizeParticipantListener listener)
listener
- listener to removepublic void addSynchronizeParticipants(ISynchronizeParticipant[] participants)
participants
- participants to addpublic void removeSynchronizeParticipants(ISynchronizeParticipant[] participants)
participants
- participants to removepublic ISynchronizeParticipantReference[] getSynchronizeParticipants()
public ISynchronizeParticipantReference[] get(String id)
id
- the type identifier for the participant
public ISynchronizeParticipantReference get(String id, String secondaryId)
id
- the type identifier for the participantsecondaryId
- the instance identifier for this participant type or null
if this participant doesn't support multiple instances.
null
if none with that id is not registered.public ISynchronizeView showSynchronizeViewInActivePage()
null
if it can't be opened.public ISynchronizeParticipantDescriptor getParticipantDescriptor(String type)
null
if a descriptor is not found for that id.
null
if a descriptor is not found for that id.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.