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

  • Method Details

    • 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