public abstract class Help extends Object
Modifier | Constructor | Description |
---|---|---|
protected |
Help() |
constructor for subclasses
|
Modifier and Type | Method | Description |
---|---|---|
abstract void |
addChangeListener(ChangeListener l) |
Add a change listener for when help sets change.
|
abstract Boolean |
isValidID(String id,
boolean force) |
Test whether a given ID is valid in some known helpset.
|
abstract void |
removeChangeListener(ChangeListener l) |
Remove a change listener.
|
void |
showHelp(org.openide.util.HelpCtx ctx) |
Shows help.
|
abstract void |
showHelp(org.openide.util.HelpCtx ctx,
boolean showmaster) |
Shows help.
|
public abstract Boolean isValidID(String id, boolean force)
id
- the ID to check for validityforce
- if false, do not do too much work (be lazy) and if necessary return null;
if true, must return non-null (meaning the call may block loading helpsets)public void showHelp(org.openide.util.HelpCtx ctx)
Note that for basic usage it may suffice to call HelpCtx.display()
,
avoiding any direct dependency on this module.
ctx
- help contextpublic abstract void showHelp(org.openide.util.HelpCtx ctx, boolean showmaster)
ctx
- help contextshowmaster
- whether to force the master helpset
to be shown (full navigators) even
though the supplied ID only applies
to one subhelpsetpublic abstract void addChangeListener(ChangeListener l)
l
- the listener to addpublic abstract void removeChangeListener(ChangeListener l)
l
- the listener to removeBuilt on April 24 2018. | Portions Copyright 1997-2018 Oracle. All rights reserved.