Package org.eclipse.compare
Interface INavigatable
-
public interface INavigatableInterface 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:
ICompareNavigator
-
-
Field Summary
Fields Modifier and Type Field Description static intFIRST_CHANGEChange flag used to navigate to the first change.static intLAST_CHANGEChange flag used to navigate to the last change.static StringNAVIGATOR_PROPERTYProperty key that can be used to associate an instance of this interface with an SWT widget usingWidget.setData(String, Object).static intNEXT_CHANGEChange flag used to navigate to the next change.static intPREVIOUS_CHANGEChange flag used to navigate to the previous change.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectgetInput()Return the input of the compare pane being navigated ornullif the pane does not have an input.booleanhasChange(int changeFlag)Return whether a call toselectChange(int)with the same parameter would succeed.booleanopenSelectedChange()Request that the currently selected change be opened.booleanselectChange(int changeFlag)Starting from the current selectionselectChangeselects and reveals the specified change.
-
-
-
Field Detail
-
NAVIGATOR_PROPERTY
static final String 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:
- Constant Field Values
-
NEXT_CHANGE
static final int NEXT_CHANGE
Change flag used to navigate to the next change.- See Also:
selectChange(int), Constant Field Values
-
PREVIOUS_CHANGE
static final int PREVIOUS_CHANGE
Change flag used to navigate to the previous change.- See Also:
selectChange(int), Constant Field Values
-
FIRST_CHANGE
static final int FIRST_CHANGE
Change flag used to navigate to the first change.- See Also:
selectChange(int), Constant Field Values
-
LAST_CHANGE
static final int LAST_CHANGE
Change flag used to navigate to the last change.- See Also:
selectChange(int), Constant Field Values
-
-
Method Detail
-
getInput
Object getInput()
Return the input of the compare pane being navigated ornullif 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 selectionselectChangeselects 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_CHANGEorLAST_CHANGE.- Returns:
- returns
trueif end (beginning) is reached,falseotherwise
-
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_CHANGEorPREVIOUS_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. Returntrueif the request resulted in the change being opened andfalseif the currently selected change could not be opened.- Returns:
- whether the selected change was opened.
-
-