1 /*
2 * $Id: IHelpCapability.java,v 1.18 2011/06/16 09:29:40 jbmeslin Exp $
3 *
4 */
5
6 package org.rcfaces.core.component.capability;
7
8 /**
9 *
10 *
11 * @author Olivier Oeuillot (latest modification by $Author: jbmeslin $)
12 * @version $Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
13 */
14 public interface IHelpCapability extends IToolTipCapability {
15
16 /**
17 * Returns a string value specifying the message to be shown by a <a
18 * href="/comps/helpMessageZoneComponent.html">helpMessageZone Component</a>.
19 *
20 * @return help message
21 */
22 String getHelpMessage();
23
24 /**
25 * Sets a string value specifying the message to be shown by a <a
26 * href="/comps/helpMessageZoneComponent.html">helpMessageZone Component</a>.
27 *
28 * @param message
29 * help message
30 */
31 void setHelpMessage(String message);
32
33 /**
34 * Returns an URL that points to a help page for the component. it is used
35 * for example by a <a href="/comps/helpButtonComponent.html">helpButton
36 * Component</a>.
37 *
38 * @return help url
39 */
40 String getHelpURL();
41
42 /**
43 * Sets an URL that points to a help page for the component. it is used for
44 * example by a <a href="/comps/helpButtonComponent.html">helpButton
45 * Component</a>.
46 *
47 * @param url
48 * help url
49 */
50 void setHelpURL(String url);
51 }