KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > INavigationLocationProvider


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.ui;
13
14 /**
15  * Should be implemented by editors that wish to contribute to the
16  * navigation history. The message <code>createNavigationLocation</code>
17  * will be sent when a new location is marked in the history.
18  *
19  * @since 2.1
20  */
21 public interface INavigationLocationProvider {
22     /**
23      * Creates an empty navigation location. The message <code>restoreState</code>
24      * will be sent to the location to restore its state.
25      *
26      * @return INavigationLocation
27      */
28     public INavigationLocation createEmptyNavigationLocation();
29
30     /**
31      * Creates a navigation location describing the current state.
32      *
33      * @return INavigationLocation
34      */
35     public INavigationLocation createNavigationLocation();
36 }
37
Popular Tags