project35.util
Class ContextHelpService

java.lang.Object
  project35.util.ContextHelpService

All Implemented Interfaces:

ContextHelpItem

public class ContextHelpService
extends java.lang.Object
implements ContextHelpItem

associates or disassociates a context help mouse listener for a component.

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),

Constructor Summary

ContextHelpService(Project35FormContext project35FormContext, java.awt.Component component)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextHelpService

public ContextHelpService(Project35FormContext project35FormContext,
                          java.awt.Component component)

Method Detail

isContextHelpEnabled

public boolean isContextHelpEnabled()

Specified by:

isContextHelpEnabled in interface ContextHelpItem

Returns:

whether context help mode is currently activated for item

getHelpLink

public java.net.URL getHelpLink()

Specified by:

getHelpLink in interface ContextHelpItem

Returns:

the URL for the HTML help page associated with the item

enableContextHelp

public void enableContextHelp(boolean enableContextHelp)

turns context help mode on or off

Specified by:

enableContextHelp in interface ContextHelpItem

Parameters:

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

setHelpLink

public void setHelpLink(java.net.URL helpLink)

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

Specified by:

setHelpLink in interface ContextHelpItem