|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the context marked for the user in the navigation history. Not intended to be implemented by clients. Clients should subclass NavigationLocation instead.
Method Summary | |
void |
dispose()
Disposes of this location and frees any allocated resource. |
Object |
getInput()
Returns the input used for this location. |
String |
getText()
Returns the display name for this location. |
boolean |
mergeInto(INavigationLocation currentLocation)
Merge the receiver into currentLocation . |
void |
releaseState()
Release any state kept by this location. |
void |
restoreLocation()
Restore the context saved by this location. |
void |
restoreState(IMemento memento)
Restore the state of this location from the memento |
void |
saveState(IMemento memento)
Persists the state of this location into the memento |
void |
setInput(Object input)
Sets the location's input. |
void |
update()
The message update is sent to the active location before
another location becomes active. |
Method Detail |
public void dispose()
public void releaseState()
public void saveState(IMemento memento)
memento
memento
- the storage were the state should be saved into.public void restoreState(IMemento memento)
memento
memento
- the storage were the state was saved into.public void restoreLocation()
public boolean mergeInto(INavigationLocation currentLocation)
currentLocation
. Return true if
the two locations could be merged otherwise return false.
This message is sent to all locations before being added to the history; given the change to the new location to merge itself into the current location minimizing the number of entries in the navigation history.
currentLocation
- where the receiver should be merged into
public Object getInput()
null
if the
receiver's state has been released.
public String getText()
public void setInput(Object input)
Should not be called by clients.
input
- the editor input.public void update()
update
is sent to the active location before
another location becomes active.
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.