1 /*
2 * Copyright 2006-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.kuali.rice.krad.uif.widget;
18
19 /**
20 * Interface for components that support help.
21 *
22 * @author Kuali Rice Team (rice.collab@kuali.org)
23 */
24 public interface Helpable {
25
26 /**
27 * Help configuration object for the container
28 *
29 * <p>
30 * External help information can be configured for the container. The
31 * {@code Help} object can the configuration for rendering a link to
32 * that help information.
33 * </p>
34 *
35 * @return Help for container
36 */
37 Help getHelp();
38
39 /**
40 * Setter for the containers help content
41 *
42 * @param help
43 */
44 void setHelp(Help help);
45
46 /**
47 * Setter for the component's tooltip.
48 *
49 * <p>
50 * This is used by the helper to set the help content to the tooltip.
51 * </p>
52 *
53 * @parm Tooltip with the help for the container
54 */
55 void setTooltipOfComponent(Tooltip tooltip);
56
57 /**
58 * Help title which is used for the HTML title attribute of the help icon
59 *
60 * @return Help title for the container
61 */
62 String getHelpTitle();
63
64 }