Package org.eclipse.ui
Interface INavigationLocation
- All Known Implementing Classes:
NavigationLocation
,TextSelectionNavigationLocation
public interface INavigationLocation
Represents the context marked for the user in the navigation history.
Not intended to be implemented by clients. Clients should subclass
NavigationLocation instead.
- Since:
- 2.1
- Restriction:
- This interface is not intended to be implemented by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
dispose()
Disposes of this location and frees any allocated resource.getId()
Returns the id used for this location.getInput()
Returns the input used for this location.getText()
Returns the display name for this location.boolean
mergeInto
(INavigationLocation currentLocation) Merge the receiver intocurrentLocation
.void
Release any state kept by this location.void
Restore the context saved by this location.void
restoreState
(IMemento memento) Restore the state of this location from thememento
void
Persists the state of this location into thememento
void
Sets the location's id.void
Sets the location's input.void
update()
The messageupdate
is sent to the active location before another location becomes active.
-
Method Details
-
dispose
void dispose()Disposes of this location and frees any allocated resource. -
releaseState
void releaseState()Release any state kept by this location. Any relevant state should be saved by the previous call of saveState(IMemento). This object will not be used until restoreState is called again. -
saveState
Persists the state of this location into thememento
- Parameters:
memento
- the storage were the state should be saved into.
-
restoreState
Restore the state of this location from thememento
- Parameters:
memento
- the storage were the state was saved into.
-
restoreLocation
void restoreLocation()Restore the context saved by this location. -
getInput
Object getInput()Returns the input used for this location. Returnsnull
if the receiver's state has been released.- Returns:
- the input for this location
-
getId
String getId()Returns the id used for this location.- Returns:
- the id for this location
- Since:
- 3.132
-
getText
String getText()Returns the display name for this location. This name is used in the navigation history list.- Returns:
- the display name
-
setInput
Sets the location's input.Should not be called by clients.
- Parameters:
input
- the editor input.
-
setId
Sets the location's id.Should not be called by clients.
- Parameters:
id
- the editor id.- Since:
- 3.132
-
update
void update()The messageupdate
is sent to the active location before another location becomes active.
-