1 /**
2 * Copyright 2005-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 package org.kuali.rice.krad.uif.widget;
17
18 /**
19 * Interface for components that support help.
20 *
21 * @author Kuali Rice Team (rice.collab@kuali.org)
22 */
23 public interface Helpable {
24
25 /**
26 * Help configuration object for the container
27 *
28 * <p>
29 * External help information can be configured for the container. The
30 * {@code Help} object can the configuration for rendering a link to
31 * that help information.
32 * </p>
33 *
34 * @return Help for container
35 */
36 Help getHelp();
37
38 /**
39 * Setter for the containers help content
40 *
41 * @param help
42 */
43 void setHelp(Help help);
44
45 /**
46 * Setter for the component's tooltip.
47 *
48 * <p>
49 * This is used by the helper to set the help content to the tooltip.
50 * </p>
51 *
52 * @parm Tooltip with the help for the container
53 */
54 void setTooltipOfComponent(Tooltip tooltip);
55
56 /**
57 * Help title which is used for the HTML title attribute of the help icon
58 *
59 * @return Help title for the container
60 */
61 String getHelpTitle();
62
63 }