KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > intro > config > IIntroXHTMLContentProvider


1 /*******************************************************************************
2  * Copyright (c) 2004, 2005 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.ui.intro.config;
12
13 import org.w3c.dom.Element JavaDoc;
14
15 /**
16  * A content provider for dynamic XHTML Intro content. When an XHTML intro page
17  * is parsed and a contentProvider element is detected, it is used to create
18  * dynamic XHTML content in the page.
19  *
20  * @since 3.1
21  */
22 public interface IIntroXHTMLContentProvider extends IIntroContentProvider {
23
24     /**
25      * Create XHTML content in the provided parent DOM Element. A typical usage
26      * for this method would be: <br>
27      *
28      * <br>
29      * <code>
30      * &lt;contentProvider id=&quot;contentProviderId&quot;
31      * class=&quot;xx.yy.IntroContentProvider&quot;
32      * pluginId=&quot;xx.yy.id&quot;/&gt; <br></code> <br>
33      *
34      * A parent DOM Element will be passed to allow for adding dynamic content
35      * by manipulating the Java XML DOM for the XHTML file. A div is created
36      * with an id equal to the id specified in the contentProvider element, and
37      * is passed as the parent. In the above example, the DOM element
38      * representing a div with id=myContentProviderDivId would be the parent
39      * passed.
40      *
41      * @param id
42      * the unique identifier of the content element. The same content
43      * provider class can be reused for several elements and the id
44      * can be used to tell them apart.
45      *
46      * @param parent
47      * the parent xml Element where dynamic content will be added as
48      * children.
49      *
50      */
51     public void createContent(String JavaDoc id, Element JavaDoc parent);
52
53
54
55 }
56
Popular Tags