Class Topic

All Implemented Interfaces:
IHelpResource, ITopic, ITopic2, IUAElement

public class Topic extends UAElement implements ITopic2
  • Field Details

  • Constructor Details

    • Topic

      public Topic()
    • Topic

      public Topic(ITopic src)
    • Topic

      public Topic(Element src)
  • Method Details

    • getIcon

      public String getIcon()
      Description copied from interface: ITopic2
      Toc elements can have non standard icons which are declared using a tocIcon element in the extension point
      Specified by:
      getIcon in interface ITopic2
      NULL if the standard icons are to be used, otherwise the name of an icon declared in an extension
    • isSorted

      public boolean isSorted()
      Description copied from interface: ITopic2
      Allows child elements to be sorted alphabetically regardless of their actual order in the list of children.
      Specified by:
      isSorted in interface ITopic2
      true if the children should be sorted alphabetically
    • getHref

      public String getHref()
      Description copied from interface: IHelpResource
      Returns the URL (as a string) associated with this help resource.
      Specified by:
      getHref in interface IHelpResource
      the URL (as a string) associated with the resource

      Valid URL of a help resource is:

      • a /pluginID/path/to/resource, where
        • pluginID is the unique identifier of the plugin containing the help resource,
        • path/to/document is the help resource path, relative to the plugin directory.
        For example. /myplugin/mytoc.xml or /myplugin/references/myclass.html are vaild.
      • string representation of URI to an external document. In this case, all special characters have to be enoded such that the URI is appropriate to be opened with a web browser. and jar:file:/c:/my%20sources/!/mypackage/MyClass.html are examples of valid URIs.
    • getLabel

      public String getLabel()
      Description copied from interface: IHelpResource
      Returns the label of this help resource.
      Specified by:
      getLabel in interface IHelpResource
      the label
    • getSubtopics

      public ITopic[] getSubtopics()
      Description copied from interface: ITopic
      Obtains the topics contained in this node.
      Specified by:
      getSubtopics in interface ITopic
      Array of ITopic
    • getCriteria

      public ICriteria[] getCriteria()
      Description copied from interface: ITopic2
      Return the criteria information of topic.
      Specified by:
      getCriteria in interface ITopic2
      array of CriterionResource
    • setHref

      public void setHref(String href)
    • setLabel

      public void setLabel(String label)