KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > help > IInclude


1 /*******************************************************************************
2  * Copyright (c) 2007 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 package org.eclipse.help;
12
13 /**
14  * A directive indicating the content at the given path should be included in
15  * this document, and replace this node.
16  *
17  * @since 3.3
18  */
19 public interface IInclude extends IUAElement {
20
21     /**
22      * An href pointing to a document element. The href has the form
23      * <code>/plugin_id/path/file.ext#anchorId</code>. For example, to include
24      * the element with id <code>myId</code> in the XML file
25      * <code>files/myFile.xml</code> under plug-in <code>my.plugin</code>, the
26      * path is <code>/my.plugin/files/myFile.xml#myId</code>.
27      *
28      * @return the path of the element to include
29      */
30     public String JavaDoc getPath();
31 }
32
Popular Tags