|
What this is
Other links
The source code/* * Sun Public License Notice * * The contents of this file are subject to the Sun Public License * Version 1.0 (the "License"). You may not use this file except in * compliance with the License. A copy of the License is available at * http://www.sun.com/ * * The Original Code is NetBeans. The Initial Developer of the Original * Code is Sun Microsystems, Inc. Portions Copyright 1997-2002 Sun * Microsystems, Inc. All Rights Reserved. */ package org.netbeans.api.javahelp; import javax.swing.event.ChangeListener; import org.openide.util.HelpCtx; /** An implementation of the JavaHelp system. * Get the concrete instance using lookup. * @author Jaroslav Tulach, Jesse Glick */ public abstract class Help { /** constructor for subclasses */ protected Help() {} /** Test whether a given ID is valid in some known helpset. * In lazy mode, should be a fast operation; if in doubt say you do not know. * @param id the ID to check for validity * @param force 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) * @return whether it is valid, if this is known; else may be null (only permitted when force is false) */ public abstract Boolean isValidID(String id, boolean force); /** Shows help. * @param ctx help context */ public void showHelp(HelpCtx ctx) { showHelp(ctx, /* #15711 */true); } /** Shows help. * @param ctx help context * @param showmaster whether to force the master helpset * to be shown (full navigators) even * though the supplied ID only applies * to one subhelpset */ public abstract void showHelp(HelpCtx ctx, boolean showmaster); /** Add a change listener for when help sets change. * @param l the listener to add */ public abstract void addChangeListener(ChangeListener l); /** Remove a change listener. * @param l the listener to remove */ public abstract void removeChangeListener(ChangeListener l); } |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.