Package org.eclipse.help

Interface IUAElement

All Known Subinterfaces:
IAnchor, ICommandLink, IContentExtension, ICriteria, ICriteriaDefinition, ICriterionDefinition, ICriterionValueDefinition, IInclude, IIndex, IIndexEntry, IIndexEntry2, IIndexSee, IIndexSubpath, ILink, IToc, IToc2, ITopic, ITopic2
All Known Implementing Classes:
Anchor, CommandLink, Include, Topic, UAElement
public interface IUAElement
An element in a UA document, which may have conditional enablement (may be filtered based on certain conditions) and may have sub-elements, or children.
Since:
3.3

  • Method Summary

    Modifier and Type
    Method
    Description
    IUAElement[]
    getChildren()
    Returns all sub-elements (children) of this element.
    boolean
    isEnabled(IEvaluationContext context)
    Returns whether or not this element should be enabled in the given context.

  • Method Details

    • isEnabled

      boolean isEnabled(IEvaluationContext context)
      Returns whether or not this element should be enabled in the given context. Elements may be hidden (filtered) if certain conditions are true.
      Parameters:
      context - the context in which the element appears
      Returns:
      whether or not the element is enabled in the given context

    • getChildren

      IUAElement[] getChildren()
      Returns all sub-elements (children) of this element.
      Returns:
      the sub-elements of this element