01: /*=============================================================================
02: * Copyright Texas Instruments, Inc., 2001. All Rights Reserved.
03: *
04: * This program is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU General Public License as published by
06: * the Free Software Foundation; either version 2 of the License, or
07: * (at your option) any later version.
08: *
09: * This program is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: * GNU General Public License for more details.
13: *
14: * You should have received a copy of the GNU General Public License
15: * along with this program; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18:
19: package ti.chimera.service;
20:
21: /**
22: * The help service provides a mechanism for registering help pages provided
23: * by a component, as well as a way to programatically display that help. The
24: * help service has the well defined name <code>"help"</code>.
25: *
26: * @author Rob Clark
27: * @version 0.1
28: */
29: public abstract class Help extends ti.chimera.Service {
30: /*=======================================================================*/
31: /**
32: * Class Constructor.
33: */
34: public Help() {
35: super ("help");
36: }
37:
38: /*=======================================================================*/
39: /**
40: * Register help. You can programmatically open help by calling
41: * {@link #displayHelp} and passing in the same path. The path is a
42: * "/" seperated path, which allows for multiple sub-headings.
43: *
44: * @param path the "/" seperated path name of the help
45: * @param url the string URL to open to view this help
46: * @param desc description of the help
47: * @see #displayHelp to programmatically display help
48: */
49: public abstract void registerHelp(String path, String url,
50: String desc);
51:
52: /**
53: * Programmatically display the specified help. If the path is
54: * <code>null</code>, then display the main help index, which is
55: * automatically generated from all the registered help pages.
56: *
57: * @param path the "/" seperated path name of the help
58: * @see #registerHelp to register help
59: */
60: public abstract void displayHelp(String path);
61: }
62:
63: /*
64: * Local Variables:
65: * tab-width: 2
66: * indent-tabs-mode: nil
67: * mode: java
68: * c-indentation-style: java
69: * c-basic-offset: 2
70: * eval: (c-set-offset 'substatement-open '0)
71: * End:
72: */
|