diff options
Diffstat (limited to 'bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java')
-rw-r--r-- | bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java | 138 |
1 files changed, 69 insertions, 69 deletions
diff --git a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java index 6eab15ad2e5..3d2139500ea 100644 --- a/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java +++ b/bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/INavigationLocation.java @@ -16,88 +16,88 @@ package org.eclipse.ui; /** * Represents the context marked for the user in the navigation history. * - * Not intended to be implemented by clients. Clients should subclass NavigationLocation - * instead. + * Not intended to be implemented by clients. Clients should subclass + * NavigationLocation instead. * * @since 2.1 * @noimplement This interface is not intended to be implemented by clients. */ public interface INavigationLocation { - /** - * Disposes of this location and frees any allocated resource. - */ - void dispose(); + /** + * Disposes of this location and frees any allocated resource. + */ + void dispose(); - /** - * 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. - */ - 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. + */ + void releaseState(); - /** - * Persists the state of this location into the <code>memento</code> - * - * @param memento the storage were the state should be saved into. - */ - void saveState(IMemento memento); + /** + * Persists the state of this location into the <code>memento</code> + * + * @param memento the storage were the state should be saved into. + */ + void saveState(IMemento memento); - /** - * Restore the state of this location from the <code>memento</code> - * - * @param memento the storage were the state was saved into. - */ - void restoreState(IMemento memento); + /** + * Restore the state of this location from the <code>memento</code> + * + * @param memento the storage were the state was saved into. + */ + void restoreState(IMemento memento); - /** - * Restore the context saved by this location. - */ - void restoreLocation(); + /** + * Restore the context saved by this location. + */ + void restoreLocation(); - /** - * Merge the receiver into <code>currentLocation</code>. Return true if - * the two locations could be merged otherwise return false. - * <p> - * 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. - * </p> - * - * @param currentLocation where the receiver should be merged into - * @return boolean true if the merge was possible - */ - boolean mergeInto(INavigationLocation currentLocation); + /** + * Merge the receiver into <code>currentLocation</code>. Return true if the two + * locations could be merged otherwise return false. + * <p> + * 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. + * </p> + * + * @param currentLocation where the receiver should be merged into + * @return boolean true if the merge was possible + */ + boolean mergeInto(INavigationLocation currentLocation); - /** - * Returns the input used for this location. Returns <code>null</code> if the - * receiver's state has been released. - * - * @return the input for this location - */ - Object getInput(); + /** + * Returns the input used for this location. Returns <code>null</code> if the + * receiver's state has been released. + * + * @return the input for this location + */ + Object getInput(); - /** - * Returns the display name for this location. This name is used in the - * navigation history list. - * - * @return the display name - */ - String getText(); + /** + * Returns the display name for this location. This name is used in the + * navigation history list. + * + * @return the display name + */ + String getText(); - /** - * Sets the location's input. - * <p> - * Should not be called by clients. - * </p> - * - * @param input the editor input. - */ - void setInput(Object input); + /** + * Sets the location's input. + * <p> + * Should not be called by clients. + * </p> + * + * @param input the editor input. + */ + void setInput(Object input); - /** - * The message <code>update</code> is sent to the active location before - * another location becomes active. - */ - void update(); + /** + * The message <code>update</code> is sent to the active location before another + * location becomes active. + */ + void update(); } |