org.rcfaces.core.component.capability
Interface IHelpCapability

All Superinterfaces:
IToolTipCapability
All Known Implementing Classes:
AbstractBasicComponent, AbstractCalendarComponent, AbstractCommandComponent, AbstractConverterCommandComponent, AbstractDataComponent, AbstractGridComponent, AbstractInputComponent, AbstractMenuComponent, AbstractMessageComponent, AbstractMessagesComponent, AbstractOutputComponent, AbstractSelectManyComponent, BoxComponent, ButtonComponent, CalendarComponent, CardBoxComponent, CardComponent, CheckButtonComponent, ComboComponent, ComboGridComponent, ComponentsGridComponent, ComponentsListComponent, CustomButtonComponent, DataGridComponent, DateChooserComponent, DateEntryComponent, ExpandBarComponent, ExternalBoxComponent, FieldSetComponent, HelpButtonComponent, HyperLinkComponent, ImageButtonComponent, ImageCheckButtonComponent, ImageComboComponent, ImageComponent, ImagePagerButtonComponent, ImageRadioButtonComponent, ImageResetButtonComponent, ImageSubmitButtonComponent, ItemsListComponent, ItemsToolFolderComponent, KeyEntryComponent, KeyLabelComponent, ListComponent, MenuBarComponent, MessageComponent, MessageFieldSetComponent, MessagesComponent, NumberEntryComponent, PagerComponent, PasswordEntryComponent, ProgressBarComponent, RadioButtonComponent, ResetButtonComponent, SpinnerComponent, StyledMessageComponent, StyledTextComponent, SubmitButtonComponent, SuggestTextEntryComponent, TabbedPaneComponent, TabComponent, TabNamingContainerComponent, TextAreaComponent, TextComponent, TextEditorComboComponent, TextEditorComponent, TextEditorImageButtonComponent, TextEditorToolFolderComponent, TextEntryComponent, TimeEntryComponent, ToolBarComponent, ToolFolderComponent, TreeComponent

public interface IHelpCapability
extends IToolTipCapability

Version:
$Revision: 1.18 $ $Date: 2011/06/16 09:29:40 $
Author:
Olivier Oeuillot (latest modification by $Author: jbmeslin $)

Method Summary
 String getHelpMessage()
          Returns a string value specifying the message to be shown by a helpMessageZone Component.
 String getHelpURL()
          Returns an URL that points to a help page for the component. it is used for example by a helpButton Component.
 void setHelpMessage(String message)
          Sets a string value specifying the message to be shown by a helpMessageZone Component.
 void setHelpURL(String url)
          Sets an URL that points to a help page for the component. it is used for example by a helpButton Component.
 
Methods inherited from interface org.rcfaces.core.component.capability.IToolTipCapability
getToolTipText, setToolTipText
 

Method Detail

getHelpMessage

String getHelpMessage()
Returns a string value specifying the message to be shown by a helpMessageZone Component.

Returns:
help message

setHelpMessage

void setHelpMessage(String message)
Sets a string value specifying the message to be shown by a helpMessageZone Component.

Parameters:
message - help message

getHelpURL

String getHelpURL()
Returns an URL that points to a help page for the component. it is used for example by a helpButton Component.

Returns:
help url

setHelpURL

void setHelpURL(String url)
Sets an URL that points to a help page for the component. it is used for example by a helpButton Component.

Parameters:
url - help url


Copyright © 2006-2011 Vedana. All Rights Reserved.