Package org.eclipse.compare
Interface INavigatable
public interface INavigatable
Interface that allow clients to navigate through the changes shown in a compare pane.
This interface may be implemented by clients.
- Since:
- 3.3
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Change flag used to navigate to the first change.static final int
Change flag used to navigate to the last change.static final String
Property key that can be used to associate an instance of this interface with an SWT widget usingWidget.setData(String, Object)
.static final int
Change flag used to navigate to the next change.static final int
Change flag used to navigate to the previous change. -
Method Summary
Modifier and TypeMethodDescriptiongetInput()
Return the input of the compare pane being navigated ornull
if the pane does not have an input.boolean
hasChange
(int changeFlag) Return whether a call toselectChange(int)
with the same parameter would succeed.boolean
Request that the currently selected change be opened.boolean
selectChange
(int changeFlag) Starting from the current selectionselectChange
selects and reveals the specified change.
-
Field Details
-
NAVIGATOR_PROPERTY
Property key that can be used to associate an instance of this interface with an SWT widget usingWidget.setData(String, Object)
.- See Also:
-
NEXT_CHANGE
static final int NEXT_CHANGEChange flag used to navigate to the next change.- See Also:
-
PREVIOUS_CHANGE
static final int PREVIOUS_CHANGEChange flag used to navigate to the previous change.- See Also:
-
FIRST_CHANGE
static final int FIRST_CHANGEChange flag used to navigate to the first change.- See Also:
-
LAST_CHANGE
static final int LAST_CHANGEChange flag used to navigate to the last change.- See Also:
-
-
Method Details
-
getInput
Object getInput()Return the input of the compare pane being navigated ornull
if the pane does not have an input.- Returns:
- the input of the compare pane being navigated or
null
-
selectChange
boolean selectChange(int changeFlag) Starting from the current selectionselectChange
selects and reveals the specified change. If the end (or beginning) is reached, the method returnstrue
.- Parameters:
changeFlag
- the change to be selected. One ofNEXT_CHANGE
,PREVIOUS_CHANGE
,FIRST_CHANGE
orLAST_CHANGE
.- Returns:
- returns
true
if end (beginning) is reached,false
otherwise
-
hasChange
boolean hasChange(int changeFlag) Return whether a call toselectChange(int)
with the same parameter would succeed.- Parameters:
changeFlag
- the change to be selected. One ofNEXT_CHANGE
orPREVIOUS_CHANGE
- Returns:
- whether a call to
selectChange(int)
with the same parameter would succeed.
-
openSelectedChange
boolean openSelectedChange()Request that the currently selected change be opened. Returntrue
if the request resulted in the change being opened andfalse
if the currently selected change could not be opened.- Returns:
- whether the selected change was opened.
-