|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that allow clients to navigate through the changes shown in a compare pane.
This interface may be implemented by clients.
ICompareNavigator
Field Summary | |
---|---|
static int |
FIRST_CHANGE
Change flag used to navigate to the first change. |
static int |
LAST_CHANGE
Change flag used to navigate to the last change. |
static String |
NAVIGATOR_PROPERTY
Property key that can be used to associate an instance of this interface with an SWT widget using Widget.setData(String, Object) . |
static int |
NEXT_CHANGE
Change flag used to navigate to the next change. |
static int |
PREVIOUS_CHANGE
Change flag used to navigate to the previous change. |
Method Summary | |
---|---|
Object |
getInput()
Return the input of the compare pane being navigated or null
if the pane does not have an input. |
boolean |
hasChange(int changeFlag)
Return whether a call to selectChange(int) with the same parameter
would succeed. |
boolean |
openSelectedChange()
Request that the currently selected change be opened. |
boolean |
selectChange(int changeFlag)
Starting from the current selection selectChange selects and reveals the specified change.
|
Field Detail |
public static final String NAVIGATOR_PROPERTY
Widget.setData(String, Object)
.
public static final int NEXT_CHANGE
selectChange(int)
,
Constant Field Valuespublic static final int PREVIOUS_CHANGE
selectChange(int)
,
Constant Field Valuespublic static final int FIRST_CHANGE
selectChange(int)
,
Constant Field Valuespublic static final int LAST_CHANGE
selectChange(int)
,
Constant Field ValuesMethod Detail |
public Object getInput()
null
if the pane does not have an input.
null
public boolean selectChange(int changeFlag)
selectChange
selects and reveals the specified change.
If the end (or beginning) is reached, the method returns true
.
changeFlag
- the change to be selected. One of NEXT_CHANGE
, PREVIOUS_CHANGE
,
FIRST_CHANGE
or LAST_CHANGE
.
true
if end (beginning) is reached, false
otherwisepublic boolean hasChange(int changeFlag)
selectChange(int)
with the same parameter
would succeed.
changeFlag
- the change to be selected. One of NEXT_CHANGE
or PREVIOUS_CHANGE
selectChange(int)
with the same parameter
would succeed.public boolean openSelectedChange()
true
if the request resulted in the change being opened and false/code> if the
currently selected change could not be opened.
- Returns:
- whether the selected change was opened.
|
Eclipse Platform Release 3.3 |
|||||||||||
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, 2007. All rights reserved.