public abstract class AbstractHelpScope
Represents a scope which can be used to specify which topics are shown in the
table of contents and which entries will show in the index. The inScope() functions
are used by the help system to determine which elements to show. Both the table of
contents and index are trees and the help system reads these trees starting with the
root and working down through the children.
In the default implementation of this method an IndexSee element is in scope
if it's target is in scope. May be overridden to exclude more IndexSee elements
from the scope
true if the target is in scope
public boolean isHierarchicalScope()
The help system can build the trees faster if it knows that an out of
scope element cannot have child elements which are in scope. This
is called a hierarchical scope. If an out of scope element can have
in scope children this function should be overridden and the help
system will perform a deeper search.
public final boolean hasInScopeChildren(IUAElement element)
Convenience method to make it easier to write subclasses
In the case of an IIndexSee element this method tests
to see if the target is in scope. For all other elements
it tests all children and if this is not a hierarchical scope
all descendants are tested.