Package org.eclipse.ui
Class NavigationLocation
- java.lang.Object
-
- org.eclipse.ui.NavigationLocation
-
- All Implemented Interfaces:
INavigationLocation
- Direct Known Subclasses:
TextSelectionNavigationLocation
public abstract class NavigationLocation extends Object implements INavigationLocation
Default implementation of INavigationLocation.- Since:
- 2.1
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
NavigationLocation(IEditorPart editorPart)
Constructs a NavigationLocation with its editor part.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
May be extended by clients.protected IEditorPart
getEditorPart()
Returns the part that the receiver holds the location for.Object
getInput()
Returns the input used for this location.String
getText()
Returns the display name for this location.void
releaseState()
May be extended by clients.void
setInput(Object input)
Sets the location's input.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.eclipse.ui.INavigationLocation
mergeInto, restoreLocation, restoreState, saveState, update
-
-
-
-
Constructor Detail
-
NavigationLocation
protected NavigationLocation(IEditorPart editorPart)
Constructs a NavigationLocation with its editor part.- Parameters:
editorPart
- the part
-
-
Method Detail
-
getEditorPart
protected IEditorPart getEditorPart()
Returns the part that the receiver holds the location for.- Returns:
- IEditorPart
-
getInput
public Object getInput()
Description copied from interface:INavigationLocation
Returns the input used for this location. Returnsnull
if the receiver's state has been released.- Specified by:
getInput
in interfaceINavigationLocation
- Returns:
- the input for this location
-
getText
public String getText()
Description copied from interface:INavigationLocation
Returns the display name for this location. This name is used in the navigation history list.- Specified by:
getText
in interfaceINavigationLocation
- Returns:
- the display name
-
setInput
public void setInput(Object input)
Description copied from interface:INavigationLocation
Sets the location's input.Should not be called by clients.
- Specified by:
setInput
in interfaceINavigationLocation
- Parameters:
input
- the editor input.
-
dispose
public void dispose()
May be extended by clients.- Specified by:
dispose
in interfaceINavigationLocation
- See Also:
INavigationLocation.dispose()
-
releaseState
public void releaseState()
May be extended by clients.- Specified by:
releaseState
in interfaceINavigationLocation
- See Also:
INavigationLocation.releaseState()
-
-