Package org.eclipse.compare
Class CompareConfiguration
java.lang.Object
org.eclipse.compare.CompareConfiguration
A
CompareConfiguration
object
controls various UI aspects of compare/merge viewers like
title labels and images, or whether a side of a merge viewer is editable.
In addition to these fixed properties CompareConfiguration
provides
API for an open ended set of properties. Different viewers which share the same
configuration can communicate via this mechanism. E.g. if a compare editor
has a button for controlling whether compare viewers ignore white space,
the button would trigger a change of the boolean IGNORE_WHITESPACE
property
and all interested viewers would receive notification.
Suitable default labels are provided (without images); both the left and right sides are editable.
Clients may use this class as is, or subclass to add new state and behavior.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
(Optional) id of the common content type for compare input detected by the compare editorstatic final String
Name of the ignore whitespace property (value"IGNORE_WHITESPACE"
).static final String
Name of the mirrored property, i.e. if left input is shown on the right side and vice versa.static final String
Name of the show pseudo conflicts property (value"SHOW_PSEUDO_CONFLICTS"
).static final String
Name of the use outline view property (value"USE_OUTLINE_VIEW"
). -
Constructor Summary
ConstructorDescriptionCreates a new configuration with editable left and right sides, suitable default labels, and no images.CompareConfiguration
(IPreferenceStore prefStore) Creates a new configuration with editable left and right sides, suitable default labels, and no images. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
dispose()
Dispose of this compare configuration.getAncestorImage
(Object element) Returns the image for the ancestor side of compare/merge viewers.getAncestorLabel
(Object element) Returns the label for the ancestor side of compare/merge viewers.Return the container of the compare associated with this configuration.getImage
(int kind) Returns an image showing the specified change kind.Returns an image showing the specified change kind applied to a given base image.Return the label provider that is used to determine the text and labels return by this compare configuration.getLeftImage
(Object element) Returns the image for the left hand side of compare/merge viewers.getLeftLabel
(Object element) Returns the label for the left hand side of compare/merge viewers.Returns the preference store of this configuration.getProperty
(String key) Returns the property with the given name, ornull
if no such property exists.getRightImage
(Object element) Returns the image for the right hand side of compare/merge viewers.getRightLabel
(Object element) Returns the label for the right hand side of compare/merge viewers.boolean
isChangeIgnored
(int kind) Return if a given change kind is ignored while computing differences between documents.boolean
Returns whether the left hand side of a merge viewer is editable.boolean
Only the views are mirrored.boolean
Returns whether the right hand side of a merge viewer is editable.void
void
setAncestorImage
(Image image) Sets the image to use for the ancestor of compare/merge viewers.void
setAncestorLabel
(String label) Sets the label to use for the ancestor of compare/merge viewers.void
setChangeIgnored
(int kind, boolean ignored) Set whether given change kind should be ignored while computing differences between documents.void
setContainer
(ICompareContainer container) Set the container of the compare associated with this configuration.void
setDefaultLabelProvider
(ICompareInputLabelProvider labelProvider) Set the default label provider for this configuration.void
setLabelProvider
(ICompareInput input, ICompareInputLabelProvider labelProvider) Set the label provider for the given compare input.void
setLeftEditable
(boolean editable) Controls whether the left side of a merge viewer is editable.void
setLeftImage
(Image image) Sets the image to use for the left side of compare/merge viewers.void
setLeftLabel
(String label) Sets the label to use for the left side of compare/merge viewers.void
setProperty
(String key, Object newValue) Sets the property with the given name.void
setRightEditable
(boolean editable) Controls whether the right side of a merge viewer is editable.void
setRightImage
(Image image) Sets the image to use for the right side of compare/merge viewers.void
setRightLabel
(String label) Sets the label to use for the right side of compare/merge viewers.
-
Field Details
-
IGNORE_WHITESPACE
Name of the ignore whitespace property (value"IGNORE_WHITESPACE"
).- See Also:
-
SHOW_PSEUDO_CONFLICTS
Name of the show pseudo conflicts property (value"SHOW_PSEUDO_CONFLICTS"
).- See Also:
-
USE_OUTLINE_VIEW
Name of the use outline view property (value"USE_OUTLINE_VIEW"
).- Since:
- 3.0
- See Also:
-
MIRRORED
Name of the mirrored property, i.e. if left input is shown on the right side and vice versa.- Since:
- 3.7
- See Also:
-
CONTENT_TYPE
(Optional) id of the common content type for compare input detected by the compare editor- Since:
- 3.11
- See Also:
-
-
Constructor Details
-
CompareConfiguration
Creates a new configuration with editable left and right sides, suitable default labels, and no images. The given preference store is used to connect this configuration with the Compare preference page propertiesComparePreferencePage.INITIALLY_SHOW_ANCESTOR_PANE
,CompareConfiguration.IGNORE_WHITESPACE
andMIRRORED
- Parameters:
prefStore
- the preference store which this configuration holds onto.- Since:
- 2.0
-
CompareConfiguration
public CompareConfiguration()Creates a new configuration with editable left and right sides, suitable default labels, and no images. This configuration uses the preference store of the Compare plug-in (CompareUIPlugin.getDefault().getPreferenceStore()
).
-
-
Method Details
-
getPreferenceStore
Returns the preference store of this configuration.- Returns:
- the preference store of this configuration.
- Since:
- 2.0
-
getImage
Returns an image showing the specified change kind. The different kind of changes are defined in theDifferencer
. Newly created images are remembered by this class and disposed when thedispose
method is called.- Parameters:
kind
- the kind of change as defined inDifferencer
.- Returns:
- an modification of the base image reflecting the kind of change
or
null
if there is no image descriptor registered for given id. - Since:
- 2.0
- See Also:
-
getImage
Returns an image showing the specified change kind applied to a given base image. The different kind of changes are defined in theDifferencer
. Typically an implementation would build a composite image from the given base image and an image representing the change kind. Newly created images are remembered by this class and disposed when thedispose
method is called.- Parameters:
base
- the image which is modified to reflect the kind of changekind
- the kind of change as defined inDifferencer
.- Returns:
- an modification of the base image reflecting the kind of change.
- See Also:
-
isMirrored
public boolean isMirrored()Only the views are mirrored. All model values for left and right are not changed!- Returns:
- true if the left and right side of the viewer are mirrored. Default is false.
- Since:
- 3.7
-
dispose
public void dispose()Dispose of this compare configuration. This method is called if the compare configuration is no longer used. An implementation must dispose of all resources. -
addPropertyChangeListener
-
removePropertyChangeListener
-
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
-
setAncestorLabel
Sets the label to use for the ancestor of compare/merge viewers. This label will be used if the element for which a label is requested does not have an ancestor or the element does not have a registered label provider or the label provider returnsnull
as the label.- Parameters:
label
- the new label for the ancestor of compare/merge viewers
-
getAncestorLabel
Returns the label for the ancestor side of compare/merge viewers. This label is typically shown in the title of the ancestor area in a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the label for the ancestor side or
null
-
setAncestorImage
Sets the image to use for the ancestor of compare/merge viewers. The CompareConfiguration does not automatically dispose the old image. This image will be used if the element for which a image is requested does not have an ancestor or the element does not have a registered label provider or the label provider returnsnull
as the image.- Parameters:
image
- the new image for the ancestor of compare/merge viewers
-
getAncestorImage
Returns the image for the ancestor side of compare/merge viewers. This image is typically shown in the title of the ancestor area in a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the image for the ancestor side or
null
-
setLeftEditable
public void setLeftEditable(boolean editable) Controls whether the left side of a merge viewer is editable.- Parameters:
editable
- if the value istrue
left side is editable
-
isLeftEditable
public boolean isLeftEditable()Returns whether the left hand side of a merge viewer is editable.- Returns:
true
if the left hand side is editable
-
setLeftLabel
Sets the label to use for the left side of compare/merge viewers. This label will be used if the element for which a label is requested does not have a left contributor or the element does not have a registered label provider or the label provider returnsnull
as the label.- Parameters:
label
- the new label for the left side of compare/merge viewers
-
getLeftLabel
Returns the label for the left hand side of compare/merge viewers. This label is typically shown in the title of the left side of a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the label for the left hand side or
null
-
setLeftImage
Sets the image to use for the left side of compare/merge viewers. The compare configuration does not automatically dispose the old image. This image will be used if the element for which a image is requested does not have an left contributor or the element does not have a registered label provider or the label provider returnsnull
as the image.- Parameters:
image
- the new image for the left side of compare/merge viewers
-
getLeftImage
Returns the image for the left hand side of compare/merge viewers. This image is typically shown in the title of the left side of a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the image for the left hand side or
null
-
setRightEditable
public void setRightEditable(boolean editable) Controls whether the right side of a merge viewer is editable.- Parameters:
editable
- if the value istrue
right side is editable
-
isRightEditable
public boolean isRightEditable()Returns whether the right hand side of a merge viewer is editable.- Returns:
true
if the right hand side is editable
-
setRightLabel
Sets the label to use for the right side of compare/merge viewers. This label will be used if the element for which a label is requested does not have an right contributor or the element does not have a registered label provider or the label provider returnsnull
as the label.- Parameters:
label
- the new label for the right side of compare/merge viewers
-
getRightLabel
Returns the label for the right hand side of compare/merge viewers. This label is typically shown in the title of the right side of a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the label for the right hand side or
null
-
setRightImage
Sets the image to use for the right side of compare/merge viewers. The compare configuration does not automatically dispose the old image. This image will be used if the element for which a image is requested does not have an right contributor or the element does not have a registered label provider or the label provider returnsnull
as the image.- Parameters:
image
- the new image for the right side of compare/merge viewers
-
getRightImage
Returns the image for the right hand side of compare/merge viewers. This image is typically shown in the title of the right side of a compare viewer.- Parameters:
element
- the input object of a compare/merge viewer ornull
- Returns:
- the image for the right hand side or
null
-
getContainer
Return the container of the compare associated with this configuration.- Returns:
- the container of the compare associated with this configuration
- Since:
- 3.3
-
setContainer
Set the container of the compare associated with this configuration.- Parameters:
container
- the container of the compare associated with this configuration.- Since:
- 3.3
-
getLabelProvider
Return the label provider that is used to determine the text and labels return by this compare configuration.- Returns:
- the label provider that is used to determine the text and labels return by this compare configuration
- Since:
- 3.3
- See Also:
-
setLabelProvider
Set the label provider for the given compare input. The compare configuration will not dispose of the label provider when the configuration is disposed. It is up to the provider of the label provider to ensure that it is disposed when it is no longer needed.- Parameters:
input
- the compare inputlabelProvider
- the label provider for the compare input- Since:
- 3.3
-
setDefaultLabelProvider
Set the default label provider for this configuration. The default label provider is used when a particular label provider has not been assigned usingsetLabelProvider(ICompareInput, ICompareInputLabelProvider)
. The compare configuration will not dispose of the label provider when the configuration is disposed. It is up to the provider of the label provider to ensure that it is disposed when it is no longer needed.- Parameters:
labelProvider
- the default label provider- Since:
- 3.3
-
setChangeIgnored
public void setChangeIgnored(int kind, boolean ignored) Set whether given change kind should be ignored while computing differences between documents. Changes specified by this method will be excluded from a comparison result.- Parameters:
kind
- type of change, possible values are:RangeDifference.CHANGE
RangeDifference.CONFLICT
RangeDifference.RIGHT
RangeDifference.LEFT
RangeDifference.ANCESTOR
RangeDifference.ERROR
ignored
- whether given kind should be included in the ignored set- Since:
- 3.5
-
isChangeIgnored
public boolean isChangeIgnored(int kind) Return if a given change kind is ignored while computing differences between documents.- Parameters:
kind
- type of change, possible values are:RangeDifference.CHANGE
RangeDifference.CONFLICT
RangeDifference.RIGHT
RangeDifference.LEFT
RangeDifference.ANCESTOR
RangeDifference.ERROR
- Returns:
- whether kind of change is ignored
- Since:
- 3.5
-