project35.util
Interface ContextHelpItem

All Known Implementing Classes:

CombinationFieldView, ContextHelpService, DataFieldView, DateFieldView, DateTimeFieldView, EditFieldView, HelpEnabledButton, HelpEnabledCheckBox, HelpEnabledCheckBoxMenuItem, HelpEnabledLabel, HelpEnabledMenu, HelpEnabledMenuItem, IDFieldView, ListFieldView, MTMVListFieldView, MTSVListFieldView, RadioFieldView, SelectColourFieldView, STMVListFieldView, STSVListFieldView, TabletIDFieldView, TabletTextFieldView, TextFieldView, URIFieldView

public interface ContextHelpItem

Interface used by JMenuItems and JCheckBoxMenuItems to have context sensitive help ability

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net),

Method Summary

void	enableContextHelp(boolean enableContextHelp) turns context help mode on or off
java.net.URL	getHelpLink()
boolean	isContextHelpEnabled()
void	setHelpLink(java.net.URL helpLink) sets the name of the help file.

Method Detail

isContextHelpEnabled

boolean isContextHelpEnabled()

Returns:

whether context help mode is currently activated for item

getHelpLink

java.net.URL getHelpLink()

Returns:

the URL for the HTML help page associated with the item

enableContextHelp

void enableContextHelp(boolean enableContextHelp)

turns context help mode on or off

Parameters:

enableContextHelp - true means context help is on; false means it's off.

setHelpLink

void setHelpLink(java.net.URL helpLink)

sets the name of the help file. Generally these documents will be located in project35/help.