|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.base.AbstractHelpScope
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.
Constructor Summary | |
---|---|
AbstractHelpScope()
|
Method Summary | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractHelpScope()
Method Detail |
---|
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 UI
public boolean inScope(IIndexSee see)
see
-
public boolean isHierarchicalScope()
public final boolean hasInScopeChildren(IUAElement element)
element
- An element which may have children
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.