Package adams.core

Interface HelpProvider

All Known Implementing Classes:

AbstractAdvancedScriptEditor, AbstractAdvancedScriptEditorWithTemplates, AbstractBaseDateTypeEditor, AbstractBasicTypePropertyEditor, AbstractDataBackedIndex, AbstractDataBackedRange, AbstractDataBackedUnorderedRange, AbstractDatabaseConnectionAwarePropertyEditorSupport, AbstractFloatingPointNumberEditor, AbstractIntegralNumberEditor, AbstractNumberEditor, AbstractPropertyEditorSupport, AbstractSimpleScriptEditor, AbstractSimpleScriptEditorWithTemplates, ActorPathEditor, BaseAnnotationEditor, BaseBooleanEditor, BaseClassnameEditor, BaseColorEditor, BaseCommandLineEditor, BaseDateEditor, BaseDateTimeEditor, BaseDateTimeMsecEditor, BaseIntervalEditor, BaseKeyValuePairEditor, BaseObjectEditor, BasePasswordEditor, BaseRegExp, BaseRegExpEditor, BaseTextEditor, BaseTimeEditor, BaseTimeMsecEditor, BooleanEditor, ByteEditor, CallableActorReferenceEditor, ColorEditor, CronSchedule, CronScheduleEditor, DateFormatString, DecimalFormatString, DoubleEditor, EmailAddressEditor, EventReferenceEditor, FieldEditor, FileEditor, FloatEditor, FlowFileEditor, FontEditor, GroovyScriptEditor, Index, IndexEditor, IntegerEditor, JdbcUrlEditor, JsonPathExpression, LongEditor, MavenArtifactEditor, MavenArtifactExclusionEditor, MavenRepositoryEditor, PdfFontEditor, PlaceholderDirectoryEditor, PlaceholderFileEditor, PrefixFieldEditor, Range, RangeEditor, SheetIndex, SheetIndexEditor, SheetRange, SheetRangeEditor, ShortEditor, SpreadSheetColumnIndex, SpreadSheetColumnIndexEditor, SpreadSheetColumnRange, SpreadSheetColumnRangeEditor, SpreadSheetRowIndex, SpreadSheetRowIndexEditor, SpreadSheetRowRange, SpreadSheetRowRangeEditor, SpreadSheetUnorderedColumnRange, SpreadSheetUnorderedColumnRangeEditor, SpreadSheetUnorderedRowRange, SpreadSheetUnorderedRowRangeEditor, StringEditor, SuffixFieldEditor, TagEditor, TriggerableEventReferenceEditor, TriStateEditor, UnorderedRange, UnorderedRangeEditor, VariableNameStorageNamePairEditor, VariableNameValuePairEditor, WekaAttributeIndex, WekaAttributeIndexEditor, WekaAttributeRange, WekaAttributeRangeEditor, WekaExperimentFileEditor, WekaLabelIndex, WekaLabelIndexEditor, WekaLabelRange, WekaLabelRangeEditor, WekaUnorderedAttributeRange, WekaUnorderedAttributeRangeEditor, XPathExpression, XSLTScriptEditor, XSLTStyleSheet

public interface HelpProvider

Interface for classes that provide some kind of help.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	getHelpDescription()	Returns a long help description, e.g., used in tiptexts.
String	getHelpIcon()	Returns the name of a help icon, e.g., used for buttons.
String	getHelpTitle()	Returns a short title for the help, e.g., used for buttons.
String	getHelpURL()	Returns a URL with additional information.

Method Detail

getHelpURL

String getHelpURL()

Returns a URL with additional information.

Returns:

the URL (or multiple URLs tab-separated), null if not available

getHelpDescription

String getHelpDescription()

Returns a long help description, e.g., used in tiptexts.

Returns:

the help text, null if not available

getHelpTitle

String getHelpTitle()

Returns a short title for the help, e.g., used for buttons.

Returns:

the short title, null if not available

getHelpIcon

String getHelpIcon()

Returns the name of a help icon, e.g., used for buttons.

Returns:

the icon name, null if not available