KickJava   Java API By Example, From Geeks To Geeks.

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


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  * An extension of a document's content.
15  *
16  * @since 3.3
17  */

18 public interface IContentExtension extends IUAElement {
19
20     /**
21      * Extension type for a contribution at an anchor.
22      */

23     public static final int CONTRIBUTION = 0;
24     
25     /**
26      * Extension type for element replacement.
27      */

28     public static final int REPLACEMENT = 1;
29
30     /**
31      * Returns the extension's content path (what to contribute into the
32      * document). This is a bundle-relative path with an id, of the form
33      * "path/file.ext#elementId".
34      *
35      * @return path to the extension's content
36      */

37     public String JavaDoc getContent();
38     
39     /**
40      * Returns the extensions target path (what to extend).
41      *
42      * @return path to the target element to extend
43      */

44     public String JavaDoc getPath();
45     
46     /**
47      * Returns the type of extension this is. Must be one of the static
48      * constants defined by this interface.
49      *
50      * @return the extension type
51      */

52     public int getType();
53 }
54
Popular Tags