001/**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.uif.widget;
017
018/**
019 * Interface for components that support help.
020 *
021 * @author Kuali Rice Team (rice.collab@kuali.org)
022 */
023public interface Helpable {
024
025    /**
026     * Help configuration object for the container
027     *
028     * <p>
029     * External help information can be configured for the container. The
030     * {@code Help} object can the configuration for rendering a link to
031     * that help information.
032     * </p>
033     *
034     * @return Help for container
035     */
036    Help getHelp();
037
038    /**
039     * Setter for the containers help content
040     *
041     * @param help
042     */
043    void setHelp(Help help);
044
045    /**
046     * Setter for the component's tooltip.
047     *
048     * <p>
049     * This is used by the helper to set the help content to the tooltip.
050     * </p>
051     *
052     *  @param tooltip Tooltip with the help for the container
053     */
054    void setTooltipOfComponent(Tooltip tooltip);
055
056    /**
057     * Help title which is used for the HTML title attribute of the help icon
058     *
059     * @return Help title for the container
060     */
061     String getHelpTitle();
062
063}