Package org.eclipse.help

Interface IToc2

All Superinterfaces:

IHelpResource, IToc, IUAElement

public interface IToc2
extends IToc

IToc2 extends IToc by adding methods to support functionality for criteria, topic sorting and custom icons

Since:

3.5

Field Summary

Fields inherited from interface org.eclipse.help.IHelpResource

HREF, LABEL

Fields inherited from interface org.eclipse.help.IToc

TOC, TOPIC

Method Summary

Modifier and Type	Method	Description
ICriteria[]	getCriteria()	Return the criteria information of this toc.
String	getIcon()	Toc elements can have non standard icons which are declared using a tocIcon element in the org.eclipse.help.toc extension point
boolean	isSorted()	Allows child elements to be sorted alphabetically regardless of their actual order in the list of children.

Methods inherited from interface org.eclipse.help.IHelpResource

getHref, getLabel

Methods inherited from interface org.eclipse.help.IToc

getTopic, getTopics

Methods inherited from interface org.eclipse.help.IUAElement

getChildren, isEnabled

Method Detail

getCriteria

ICriteria[] getCriteria()

Return the criteria information of this toc.

Returns:

array of CriterionResource

getIcon

String getIcon()

Toc elements can have non standard icons which are declared using a tocIcon element in the org.eclipse.help.toc extension point

Returns:

NULL if the standard icons are to be used, otherwise the name of an icon declared in an org.eclipse.help.toc extension

isSorted

boolean isSorted()

Allows child elements to be sorted alphabetically regardless of their actual order in the list of children.

Returns:

true if the children should be sorted alphabetically