Package org.eclipse.team.ui.synchronize
Interface ISynchronizePageConfiguration
public interface ISynchronizePageConfiguration
Configures the model, actions and label decorations of an
ISynchronizePage
. Clients can:
- set properties to affect the page contents and react to property changes
- add and configure the actions available to the user (context menu, toolbar and view menu)
- Since:
- 3.0
- Restriction:
- This interface is not intended to be implemented by clients.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final String[]
These are the default groups used for the context menu of a page.static final String[]
These are the default groups used for the toolbar of a page.static final String[]
These are the default groups used for the drop-down view menu of a page.static final String
The id of the edit group that determines where the edit actions appear (e.g. move and delete).static final String
The id of the file group that determines where the file actions appear.static final int
Modes are direction filters for the viewstatic final String
The id of the layout group that determines whether the layout selection actions appear in the view drop-down or toolbar.static final String
The id of the mode group that determines where the mode selection actions appearstatic final String
The id of the navigate group that determines where the navigation actions appearstatic final String
The id of the group that determines where workbench object contributions should appear.static final int
static final String
Property constant for the type of comparison used to create theSyncInfo
in the P_SYNC_INFO_SET property.static final String
The configuration property that defines the groups in the context menu of the page.static final String
Property constant for the list of label decorators (instance ofILabelDecorator[]
) that will be applied to the text and image from the label provider.static final String
Property constant for the mode used to filter the visible elements of the model.static final String
The configuration property that defines the filter id that determines which object contribution actions appear in the context menu for the page.static final String
Property constant for the description (String) of the page that appears as the description of the view when the page is active.static final String
Property constant which indicates which modes are to be available to the user.static final String
Property constant for theSyncInfoSet
that is being displayed by the page.static final String
Property constant that defines the groups in the toolbar menu of the page.static final String
Property constant that defines the groups in the drop-down view menu of the page.static final String
Property constant for the id of the viewer to be used for this page.static final String
The id of the preferences group that determines whether the preferences actions appear in the view drop-down.static final String
The id of the sort group that determines where sort actions or submenus appear.static final String
The id of the synchronize group the determines where the synchronize actions appear.static final String
static final String
Comparison type constants -
Method Summary
Modifier and TypeMethodDescriptionvoid
Register the action group with the configuration.void
addLabelDecorator
(ILabelDecorator decorator) Add a label decorator to the page configuration.void
addMenuGroup
(String menuPropertyId, String groupId) Adds a menu group of the given id to the end of the menu groups list for the given menu property id.void
Add a property change listener to the configuration.Return the comparison type used by the page'sSyncInfo
modes.int
getMode()
Return the value of the P_MODE property of this configuration.getPage()
Return the page created from and associated with this configuration.Return the participant associated with this configuration.getProperty
(String key) Returns the property with the given name, ornull
if no such property exists.Return the runnable context.getSite()
Return the site which provides access to certain workbench services.int
Return the value of the P_SUPPORTED_MODES property of this configuration.Return the set associated with the P_SYNC_INFO_SET property ornull
if the property is not set.Return the id of the viewer to which this configuration is associated.boolean
hasMenuGroup
(String menuPropertyId, String groupId) Returns whether the given group appears in the given menuvoid
Remove a previously registered action group.void
Remove the registered change listener.void
setComparisonType
(String type) Set the comparison type used by the page'sSyncInfo
modes.void
setMenuGroups
(String menuPropertyId, String[] groups) Set the groups that are to be added to the menu identified by the menu property id.void
setMode
(int mode) Set the P_MODE property of this configuration to the given mode flag (one ofINCOMING_MODE
,OUTGOING_MODE
,BOTH_MODE
orCONFLICTING_MODE
).void
setPage
(ISynchronizePage page) Set the page for this configuration.void
setProperty
(String key, Object newValue) Sets the property with the given name.void
setRunnableContext
(IRunnableContext context) Sets the runnable context that can be used by the page's actions to display progress.void
setSupportedModes
(int modes) Set the P_SUPPORTED_MODES property of this configuration to the given combination of one or more mode flags (INCOMING_MODE
,OUTGOING_MODE
,BOTH_MODE
andCONFLICTING_MODE
).
-
Field Details
-
P_SYNC_INFO_SET
Property constant for theSyncInfoSet
that is being displayed by the page. Some pages may not be displaying the contents of aSyncInfoSet
in which case the value associated with this property will benull
.- See Also:
-
P_LABEL_DECORATORS
Property constant for the list of label decorators (instance ofILabelDecorator[]
) that will be applied to the text and image from the label provider.- See Also:
-
P_TOOLBAR_MENU
Property constant that defines the groups in the toolbar menu of the page. The value for this property should be a string array. If this property is set tonull
, theDEFAULT_TOOLBAR_MENU
is used. Also, the groups mentioned in theDEFAULT_TOOLBAR_MENU
can be removed but will always appear in the same order if included.- See Also:
-
P_CONTEXT_MENU
The configuration property that defines the groups in the context menu of the page. The value for this property should be a string array.- See Also:
-
P_VIEW_MENU
Property constant that defines the groups in the drop-down view menu of the page. The value for this property should be a string array. If this property is set tonull
, theDEFAULT_VIEW_MENU
is used. Also, the groups mentioned in theDEFAULT_VIEW_MENU
can be removed but will always appear in the same order if included.- See Also:
-
P_OBJECT_CONTRIBUTION_ID
The configuration property that defines the filter id that determines which object contribution actions appear in the context menu for the page. This defaults to the id of the participant but can be set to another id ornull
- Since:
- 3.1
- See Also:
-
P_COMPARISON_TYPE
Property constant for the type of comparison used to create theSyncInfo
in the P_SYNC_INFO_SET property. If the comparison type isTHREE_WAY
then modes selection applies.- See Also:
-
P_MODE
Property constant for the mode used to filter the visible elements of the model. The value can be one of the mode integer constants.- See Also:
-
P_SUPPORTED_MODES
Property constant which indicates which modes are to be available to the user. The value is to be an integer that combines one or more of the mode bit values. Eithernull
or0
can be used to indicate that mode filtering is not supported.- See Also:
-
P_VIEWER_ID
Property constant for the id of the viewer to be used for this page. The viewer id corresponds to the viewer definition in the Common Navigator framework.- Since:
- 3.2
- See Also:
-
P_PAGE_DESCRIPTION
Property constant for the description (String) of the page that appears as the description of the view when the page is active.- Since:
- 3.2
- See Also:
-
SYNCHRONIZE_GROUP
The id of the synchronize group the determines where the synchronize actions appear.- See Also:
-
NAVIGATE_GROUP
The id of the navigate group that determines where the navigation actions appear- See Also:
-
SORT_GROUP
The id of the sort group that determines where sort actions or submenus appear.- Since:
- 3.1
- See Also:
-
MODE_GROUP
The id of the mode group that determines where the mode selection actions appear- See Also:
-
FILE_GROUP
The id of the file group that determines where the file actions appear. File actions include the open actions.- See Also:
-
EDIT_GROUP
The id of the edit group that determines where the edit actions appear (e.g. move and delete).- See Also:
-
PREFERENCES_GROUP
The id of the preferences group that determines whether the preferences actions appear in the view drop-down.- See Also:
-
OBJECT_CONTRIBUTIONS_GROUP
The id of the group that determines where workbench object contributions should appear. This group will only be used if there is an OBJECT_CONTRIBUTION_ID set in the configuration- Since:
- 3.1
- See Also:
-
LAYOUT_GROUP
The id of the layout group that determines whether the layout selection actions appear in the view drop-down or toolbar.- See Also:
-
DEFAULT_CONTEXT_MENU
These are the default groups used for the context menu of a page. Clients can remove, add and change the ordering for groups in the context menu. -
DEFAULT_TOOLBAR_MENU
These are the default groups used for the toolbar of a page. These groups will always appear in this order in the toolbar. Clients can disable one or more of these groups by setting theP_TOOLBAR_MENU
property to an array that contains a subset of these. Clients can also add groups by adding new unique group ids to the array. Added groups will appear in the order specified but after the default groups. -
DEFAULT_VIEW_MENU
These are the default groups used for the drop-down view menu of a page. These groups will always appear in this order in the view menu. Clients can disable one or more of these groups by setting theP_VIEW_MENU
property to an array that contains a subset of these. Clients can also add groups by adding new unique group ids to the array. Added groups will appear in the order specified but after the default groups. -
TWO_WAY
Comparison type constants- See Also:
-
THREE_WAY
- See Also:
-
INCOMING_MODE
static final int INCOMING_MODEModes are direction filters for the view- See Also:
-
OUTGOING_MODE
static final int OUTGOING_MODE- See Also:
-
BOTH_MODE
static final int BOTH_MODE- See Also:
-
CONFLICTING_MODE
static final int CONFLICTING_MODE- See Also:
-
ALL_MODES
static final int ALL_MODES- See Also:
-
-
Method Details
-
getParticipant
ISynchronizeParticipant getParticipant()Return the participant associated with this configuration.- Returns:
- the participant
-
getSite
ISynchronizePageSite getSite()Return the site which provides access to certain workbench services.- Returns:
- the page site
-
getPage
ISynchronizePage getPage()Return the page created from and associated with this configuration.- Returns:
- Returns the page for this configuration
-
setPage
Set the page for this configuration. This method should only be called once by theISynchronizeParticipant
that created the page.- Parameters:
page
- the configuration's page
-
addPropertyChangeListener
Add a property change listener to the configuration. Registered listeners will receive notification when any property changes.- Parameters:
listener
- a property change listener
-
removePropertyChangeListener
Remove the registered change listener. Removing an unregistered listener has no effects.- Parameters:
listener
- a property change listener
-
setProperty
Sets the property with the given name. If the new value differs from the old aPropertyChangeEvent
is sent to registered listeners.- Parameters:
key
- the name of the property to setnewValue
- the new value of the property
-
getProperty
Returns the property with the given name, ornull
if no such property exists.- Parameters:
key
- the name of the property to retrieve- Returns:
- the property with the given name, or
null
if not found
-
addActionContribution
Register the action group with the configuration. The registered action groups will have the opportunity to add actions to the action bars and context menu of the synchronize page created using the configuration.- Parameters:
group
- a synchronize page action group
-
removeActionContribution
Remove a previously registered action group. Removing a group that is not registered has no effect.- Parameters:
group
- a synchronize page action group
-
addLabelDecorator
Add a label decorator to the page configuration.- Parameters:
decorator
- a label decorator
-
setMenuGroups
Set the groups that are to be added to the menu identified by the menu property id.- Parameters:
menuPropertyId
- the menu property id (one ofP_CONTEXT_MENU
,P_VIEW_MENU
orP_TOOLBAR_MENU
)groups
- a array of groups Ids
-
addMenuGroup
Adds a menu group of the given id to the end of the menu groups list for the given menu property id.- Parameters:
menuPropertyId
- the menu property id (one ofP_CONTEXT_MENU
,P_VIEW_MENU
orP_TOOLBAR_MENU
)groupId
- the id of the group to be added to the end of the menu group list
-
hasMenuGroup
Returns whether the given group appears in the given menu- Parameters:
menuPropertyId
- the property id that identifies the menugroupId
- the id of the group- Returns:
true
if the group identified by the groupId appears in the menu identified by the menuPropertyId andfalse
otherwise
-
getMode
int getMode()Return the value of the P_MODE property of this configuration.- Returns:
- the mode property value
-
setMode
void setMode(int mode) Set the P_MODE property of this configuration to the given mode flag (one ofINCOMING_MODE
,OUTGOING_MODE
,BOTH_MODE
orCONFLICTING_MODE
).- Parameters:
mode
- the mode value
-
getSupportedModes
int getSupportedModes()Return the value of the P_SUPPORTED_MODES property of this configuration.- Returns:
- the supported modes property value
-
setSupportedModes
void setSupportedModes(int modes) Set the P_SUPPORTED_MODES property of this configuration to the given combination of one or more mode flags (INCOMING_MODE
,OUTGOING_MODE
,BOTH_MODE
andCONFLICTING_MODE
).- Parameters:
modes
- the supported modes
-
getSyncInfoSet
SyncInfoSet getSyncInfoSet()Return the set associated with the P_SYNC_INFO_SET property ornull
if the property is not set.- Returns:
- the set associated with the P_SYNC_INFO_SET property
or
null
if the property is not set
-
getComparisonType
String getComparisonType()Return the comparison type used by the page'sSyncInfo
modes.- Returns:
- comparison type (could be
TWO_WAY
,THREE_WAY
or a custom type).
-
setComparisonType
Set the comparison type used by the page'sSyncInfo
modes. The default type isTHREE_WAY
.- Parameters:
type
- the comparison type (could beTWO_WAY
,THREE_WAY
or a custom type).
-
setRunnableContext
Sets the runnable context that can be used by the page's actions to display progress.- Parameters:
context
- a runnable context (or null)
-
getRunnableContext
IRunnableContext getRunnableContext()Return the runnable context. Ifnull
is returned, actions can use their own method of progress feedback either using a background job or the progress service- Returns:
- a runnable context (or
null
)
-
getViewerId
String getViewerId()Return the id of the viewer to which this configuration is associated.- Returns:
- the id of the viewer to which this configuration is associated
- Since:
- 3.2
-