org.povclipse2.tools.swt.editor

Class HelpLinkBooleanTooltipFieldEditor

java.lang.Object

BooleanFieldEditor

org.povclipse2.tools.swt.editor.BooleanTooltipFieldEditor

org.povclipse2.tools.swt.editor.HelpLinkBooleanTooltipFieldEditor

public class HelpLinkBooleanTooltipFieldEditor
extends BooleanTooltipFieldEditor

BooleanTooltipFieldEditor enhanced with support for a help button linking to an Eclipse help entry.

Author:

Wolfgang Möstl

Constructor Summary

Constructors

Constructor and Description
HelpLinkBooleanTooltipFieldEditor() Default constructor
HelpLinkBooleanTooltipFieldEditor(java.lang.String name, java.lang.String label, java.lang.String tooltip, Composite parent, java.lang.String helpURL, java.lang.String helpImageTooltip) Constructor setting all parameters
HelpLinkBooleanTooltipFieldEditor(java.lang.String name, java.lang.String labelText, java.lang.String tooltip, int style, Composite parent, java.lang.String helpURL, java.lang.String helpImageTooltip) Constructor setting all parameters

Method Summary

Modifier and Type	Method and Description
protected void	adjustForNumColumns(int numColumns)
protected void	doFillIntoGrid(Composite parent, int numColumns)
int	getNumberOfControls()
void	setEnabled(boolean enabled, Composite parent)

Methods inherited from class org.povclipse2.tools.swt.editor.BooleanTooltipFieldEditor

getCheckBox, setCheckBoxEnabled, setTooltipText

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpLinkBooleanTooltipFieldEditor

public HelpLinkBooleanTooltipFieldEditor()

Default constructor

HelpLinkBooleanTooltipFieldEditor

public HelpLinkBooleanTooltipFieldEditor(java.lang.String name,
                                         java.lang.String label,
                                         java.lang.String tooltip,
                                         Composite parent,
                                         java.lang.String helpURL,
                                         java.lang.String helpImageTooltip)

Constructor setting all parameters

Parameters:

name - the name of the preference this field editor works on

label - the label text of the field editor

tooltip - the tooltip to be displayed on the checkbox and the label

parent - the parent of the field editor's control

helpURL - the URL to the help item to display

helpImageTooltip - the tooltip to be displayed for the help link icon

HelpLinkBooleanTooltipFieldEditor

public HelpLinkBooleanTooltipFieldEditor(java.lang.String name,
                                         java.lang.String labelText,
                                         java.lang.String tooltip,
                                         int style,
                                         Composite parent,
                                         java.lang.String helpURL,
                                         java.lang.String helpImageTooltip)

Constructor setting all parameters

Parameters:

name - the name of the preference this field editor works on

labelText - the label text of the field editor

tooltip - the tooltip to be displayed on the checkbox and the label

style - The check box style to be used

parent - the parent of the field editor's control

helpURL - the URL to the help item to display

helpImageTooltip - the tooltip to be displayed for the help link icon

Method Detail

doFillIntoGrid

protected void doFillIntoGrid(Composite parent,
                              int numColumns)

See Also:

org.eclipse.jface.preference.StringButtonFieldEditor#doFillIntoGrid(org.eclipse.swt.widgets.Composite, int)

getNumberOfControls

public int getNumberOfControls()

See Also:

org.eclipse.jface.preference.StringButtonFieldEditor#getNumberOfControls()

adjustForNumColumns

protected void adjustForNumColumns(int numColumns)

See Also:

org.eclipse.jface.preference.StringButtonFieldEditor#adjustForNumColumns(int)

setEnabled

public void setEnabled(boolean enabled,
                       Composite parent)

See Also:

org.eclipse.jface.preference.StringButtonFieldEditor#setEnabled(boolean, org.eclipse.swt.widgets.Composite)