|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISynchronizePageConfiguration
Configures the model, actions and label decorations of an
ISynchronizePage
. Clients can:
This interface is not intended to be implemented by clients.
Field Summary | |
---|---|
static int |
ALL_MODES
|
static int |
BOTH_MODE
|
static int |
CONFLICTING_MODE
|
static java.lang.String[] |
DEFAULT_CONTEXT_MENU
These are the default groups used for the context menu of a page. |
static java.lang.String[] |
DEFAULT_TOOLBAR_MENU
These are the default groups used for the toolbar of a page. |
static java.lang.String[] |
DEFAULT_VIEW_MENU
These are the default groups used for the dropdown view menu of a page. |
static java.lang.String |
EDIT_GROUP
The id of the edit group that determines where the edit actions appear (e.g. move and delete). |
static java.lang.String |
FILE_GROUP
The id of the file group that determines where the file actions appear. |
static int |
INCOMING_MODE
Modes are direction filters for the view |
static java.lang.String |
LAYOUT_GROUP
The id of the layout group that determines whether the layout selection actions appear in the view dropdown or toolbar. |
static java.lang.String |
MODE_GROUP
The id of the mode group that determines where the mode selection actions appear |
static java.lang.String |
NAVIGATE_GROUP
The id of the navigate group that determines where the navigation actions appear |
static java.lang.String |
OBJECT_CONTRIBUTIONS_GROUP
The id of the group that determines where workbench object contributions should appear. |
static int |
OUTGOING_MODE
|
static java.lang.String |
P_COMPARISON_TYPE
Property constant for the type of comparison used to create the SyncInfo in the P_SYNC_INFO_SET property. |
static java.lang.String |
P_CONTEXT_MENU
The configuration property that defines the groups in the context menu of the page. |
static java.lang.String |
P_LABEL_DECORATORS
Property constant for the list of label decorators (instance of ILabelDecorator[] ) that will be
applied to the text and image from the label provider. |
static java.lang.String |
P_MODE
Property constant for the mode used to filter the visible elements of the model. |
static java.lang.String |
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. |
static java.lang.String |
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. |
static java.lang.String |
P_SUPPORTED_MODES
Property constant which indicates which modes are to be available to the user. |
static java.lang.String |
P_SYNC_INFO_SET
Property constant for the SyncInfoSet that is being
displayed by the page. |
static java.lang.String |
P_TOOLBAR_MENU
Property constant that defines the groups in the toolbar menu of the page. |
static java.lang.String |
P_VIEW_MENU
Property constant that defines the groups in the dropdown view menu of the page. |
static java.lang.String |
P_VIEWER_ID
Property constant for the id of the viewer to be used for this page. |
static java.lang.String |
PREFERENCES_GROUP
The id of the preferences group that determines whether the preferences actions appear in the view dropdown. |
static java.lang.String |
SORT_GROUP
The id of the sort group that determines where sort actions or submenus appear. |
static java.lang.String |
SYNCHRONIZE_GROUP
The id of the synchronize group the determines where the synchronize actions appear. |
static java.lang.String |
THREE_WAY
|
static java.lang.String |
TWO_WAY
Comparison type constants |
Method Summary | |
---|---|
void |
addActionContribution(SynchronizePageActionGroup group)
Register the action group with the configuration. |
void |
addLabelDecorator(ILabelDecorator decorator)
Add a label decorator to the page configuration. |
void |
addMenuGroup(java.lang.String menuPropertyId,
java.lang.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 |
addPropertyChangeListener(IPropertyChangeListener listener)
Add a property change listener to the configuration. |
java.lang.String |
getComparisonType()
Return the comparison type used by the page's SyncInfo
modes. |
int |
getMode()
Return the value of the P_MODE property of this configuration. |
ISynchronizePage |
getPage()
Return the page created from and associated with this configuration. |
ISynchronizeParticipant |
getParticipant()
Return the participant associated with this configuration. |
java.lang.Object |
getProperty(java.lang.String key)
Returns the property with the given name, or null
if no such property exists. |
IRunnableContext |
getRunnableContext()
Return the runnable context. |
ISynchronizePageSite |
getSite()
Return the site which provides access to certain workbench services. |
int |
getSupportedModes()
Return the value of the P_SUPPORTED_MODES property of this configuration. |
SyncInfoSet |
getSyncInfoSet()
Return the set associated with the P_SYNC_INFO_SET property or null if the property is not set. |
java.lang.String |
getViewerId()
Return the id of the viewer to which this configuration is associated. |
boolean |
hasMenuGroup(java.lang.String menuPropertyId,
java.lang.String groupId)
Returns whether the given group appears in the given menu |
void |
removeActionContribution(SynchronizePageActionGroup group)
Remove a previously registered action group. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Remove the registered change listener. |
void |
setComparisonType(java.lang.String type)
Set the comparison type used by the page's SyncInfo
modes. |
void |
setMenuGroups(java.lang.String menuPropertyId,
java.lang.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 of INCOMING_MODE ,
OUTGOING_MODE , BOTH_MODE
or CONFLICTING_MODE ). |
void |
setPage(ISynchronizePage page)
Set the page for this configuration. |
void |
setProperty(java.lang.String key,
java.lang.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 ORed combination of one or more mode flags ( INCOMING_MODE ,
OUTGOING_MODE , BOTH_MODE
and CONFLICTING_MODE ). |
Field Detail |
---|
static final java.lang.String P_SYNC_INFO_SET
SyncInfoSet
that is being
displayed by the page. Some pages may not be displaying the
contents of a SyncInfoSet
in which case the value
associated with this property will be null
.
static final java.lang.String P_LABEL_DECORATORS
ILabelDecorator[]
) that will be
applied to the text and image from the label provider.
static final java.lang.String P_TOOLBAR_MENU
null
, the DEFAULT_TOOLBAR_MENU
is used. Also, the groups mentioned in the DEFAULT_TOOLBAR_MENU
can be removed but will always appear in the same order if
included.
static final java.lang.String P_CONTEXT_MENU
static final java.lang.String P_VIEW_MENU
null
, the DEFAULT_VIEW_MENU
is used. Also, the groups mentioned in the DEFAULT_VIEW_MENU
can be removed but will always appear in the same order if
included.
static final java.lang.String P_OBJECT_CONTRIBUTION_ID
null
static final java.lang.String P_COMPARISON_TYPE
SyncInfo
in the P_SYNC_INFO_SET property.
If the comparison type is THREE_WAY
then
modes selection applies.
static final java.lang.String P_MODE
static final java.lang.String P_SUPPORTED_MODES
null
or 0
can be used to indicate that
mode filtering is not supported.
static final java.lang.String P_VIEWER_ID
static final java.lang.String P_PAGE_DESCRIPTION
static final java.lang.String SYNCHRONIZE_GROUP
static final java.lang.String NAVIGATE_GROUP
static final java.lang.String SORT_GROUP
static final java.lang.String MODE_GROUP
static final java.lang.String FILE_GROUP
static final java.lang.String EDIT_GROUP
static final java.lang.String PREFERENCES_GROUP
static final java.lang.String OBJECT_CONTRIBUTIONS_GROUP
static final java.lang.String LAYOUT_GROUP
static final java.lang.String[] DEFAULT_CONTEXT_MENU
static final java.lang.String[] DEFAULT_TOOLBAR_MENU
P_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.
static final java.lang.String[] DEFAULT_VIEW_MENU
P_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.
static final java.lang.String TWO_WAY
static final java.lang.String THREE_WAY
static final int INCOMING_MODE
static final int OUTGOING_MODE
static final int BOTH_MODE
static final int CONFLICTING_MODE
static final int ALL_MODES
Method Detail |
---|
ISynchronizeParticipant getParticipant()
ISynchronizePageSite getSite()
ISynchronizePage getPage()
void setPage(ISynchronizePage page)
ISynchronizeParticipant
that created
the page.
page
- the configuration's pagevoid addPropertyChangeListener(IPropertyChangeListener listener)
listener
- a property change listenervoid removePropertyChangeListener(IPropertyChangeListener listener)
listener
- a property change listenervoid setProperty(java.lang.String key, java.lang.Object newValue)
PropertyChangeEvent
is sent to registered listeners.
key
- the name of the property to setnewValue
- the new value of the propertyjava.lang.Object getProperty(java.lang.String key)
null
if no such property exists.
key
- the name of the property to retrieve
null
if not foundvoid addActionContribution(SynchronizePageActionGroup group)
group
- a synchronize page action groupvoid removeActionContribution(SynchronizePageActionGroup group)
group
- a synchronize page action groupvoid addLabelDecorator(ILabelDecorator decorator)
decorator
- a label decoratorvoid setMenuGroups(java.lang.String menuPropertyId, java.lang.String[] groups)
menuPropertyId
- the menu property id (one of P_CONTEXT_MENU
,
P_VIEW_MENU
or P_TOOLBAR_MENU
)groups
- a array of groups Idsvoid addMenuGroup(java.lang.String menuPropertyId, java.lang.String groupId)
menuPropertyId
- the menu property id (one of P_CONTEXT_MENU
,
P_VIEW_MENU
or P_TOOLBAR_MENU
)groupId
- the id of the group to be added to the end of the menu
group listboolean hasMenuGroup(java.lang.String menuPropertyId, java.lang.String groupId)
menuPropertyId
- the property id that identifies the menugroupId
- the id of the group
true
if the group identified by the groupId appears
in the menu identified by the menuPropertyId and false
otherwiseint getMode()
void setMode(int mode)
INCOMING_MODE
,
OUTGOING_MODE
, BOTH_MODE
or CONFLICTING_MODE
).
mode
- the mode valueint getSupportedModes()
void setSupportedModes(int modes)
INCOMING_MODE
,
OUTGOING_MODE
, BOTH_MODE
and CONFLICTING_MODE
).
modes
- the supported modesSyncInfoSet getSyncInfoSet()
null
if the property is not set.
null
if the property is not setjava.lang.String getComparisonType()
SyncInfo
modes.
TWO_WAY
, THREE_WAY
or a custom type).void setComparisonType(java.lang.String type)
SyncInfo
modes. The default type is THREE_WAY
.
type
- the comparison type (could be TWO_WAY
, THREE_WAY
or a custom type).void setRunnableContext(IRunnableContext context)
context
- a runnable context (or null)IRunnableContext getRunnableContext()
null
is returned,
actions can use their own method of progress feedback either
using a background job or the progress service
null
)java.lang.String getViewerId()
|
Eclipse Platform Release 3.2 |
|||||||||
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, 2006. All rights reserved.