public abstract class AbstractHelpScope extends Object
Constructor and Description |
---|
AbstractHelpScope() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getName(Locale locale)
a single information center instance can display content in multiple locales.
|
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.
|
abstract boolean |
inScope(IIndexEntry entry)
Determine whether an index entry is in scope
|
boolean |
inScope(IIndexSee see)
In the default implementation of this method an IndexSee element is in scope
if it's target is in scope.
|
abstract boolean |
inScope(IToc toc)
Determine whether a table of contents is in scope
|
abstract boolean |
inScope(ITopic topic)
Determine whether a topic is in scope
|
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.
|
public abstract boolean inScope(IToc toc)
public abstract boolean inScope(ITopic topic)
public abstract boolean inScope(IIndexEntry entry)
public abstract String getName(Locale locale)
locale
- a string representing the locale used for the UIpublic boolean inScope(IIndexSee see)
see
- public boolean isHierarchicalScope()
public final boolean hasInScopeChildren(IUAElement element)
element
- An element which may have children
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.