org.kuali.rice.krad.uif.widget

Interface Helpable

All Known Subinterfaces:

CollectionGroup, Container, DataField, Group, InputField, PageGroup

All Known Implementing Classes:

AccordionGroup, CollectionGroupBase, ComponentLibraryView, ContainerBase, DataFieldBase, DialogGroup, DocumentView, FormView, GroupBase, IframeView, InputFieldBase, InquiryView, LightTable, LinkGroup, LookupInputField, LookupView, MaintenanceDocumentView, MessageView, MockView, PageGroupBase, SidebarNavigationGroup, TabGroup, TabNavigationGroup, TransactionalDocumentView, TreeGroup, View, WizardGroup

public interface Helpable

Interface for components that support help.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Help	getHelp() Help configuration object for the container
String	getHelpTitle() Help title which is used for the HTML title attribute of the help icon
void	setHelp(Help help) Setter for the containers help content
void	setTooltipOfComponent(Tooltip tooltip) Setter for the component's tooltip.

Method Detail

getHelp

Help getHelp()

Help configuration object for the container

External help information can be configured for the container. The Help object can the configuration for rendering a link to that help information.

Returns:

Help for container

setHelp

void setHelp(Help help)

Setter for the containers help content

Parameters:

help -

setTooltipOfComponent

void setTooltipOfComponent(Tooltip tooltip)

Setter for the component's tooltip.

This is used by the helper to set the help content to the tooltip.

Parameters:

tooltip - Tooltip with the help for the container

getHelpTitle

String getHelpTitle()

Help title which is used for the HTML title attribute of the help icon

Returns:

Help title for the container