KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > help > internal > model > ITocElement


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 package org.eclipse.help.internal.model;
12
13 import java.util.List JavaDoc;
14
15 import org.eclipse.help.*;
16
17 /**
18  * Part of help navigation model corresponding to TOC element. It may contain
19  * TOPIC, LINK, or ANCHOR elements.
20  *
21  * @since 3.0
22  */
23 public interface ITocElement extends IToc, INavigationElement {
24     /**
25      * @return the URL (as a string) of description topic.
26      */
27     public String JavaDoc getTocTopicHref();
28     /**
29      * Returns a topic with the specified href defined by this TOC, without
30      * looking in children TOCs <br>
31      * If the TOC contains multiple topics with the same href only of them
32      * (arbitrarily chosen) will be returned. TOC Descritpion topic is ignored.
33      *
34      * @param href
35      * the topic's URL.
36      * @return ITopic or null
37      */
38     public ITopic getOwnedTopic(String JavaDoc href);
39     /**
40      * Returns a topic with the specified href found in extra dir defined by
41      * this TOC, without looking in children TOCs
42      *
43      * @param href
44      * the topic's URL.
45      * @return ITopic or null
46      */
47     public ITopic getOwnedExtraTopic(String JavaDoc href);
48     /**
49      * Gets the childrenTocs.
50      *
51      * @return Returns a List of ITocElement
52      */
53     public List JavaDoc getChildrenTocs();
54 }
55
Popular Tags