org.povclipse2.tools.swt.editor

Class BooleanTooltipFieldEditor

java.lang.Object

BooleanFieldEditor

org.povclipse2.tools.swt.editor.BooleanTooltipFieldEditor

Direct Known Subclasses:

HelpLinkBooleanTooltipFieldEditor

public class BooleanTooltipFieldEditor
extends BooleanFieldEditor

org.eclipse.jface.preference.BooleanFieldEditor enhanced with support for tooltips.

Author:

Wolfgang Möstl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BooleanTooltipFieldEditor() Default constructor.
	BooleanTooltipFieldEditor(java.lang.String name, java.lang.String label, java.lang.String tooltip, Composite parent) Creates a boolean field editor in the default style.
	BooleanTooltipFieldEditor(java.lang.String name, java.lang.String labelText, java.lang.String tooltip, int style, Composite parent) Creates a boolean field editor in the given style.

Method Summary

Modifier and Type	Method and Description
Button	getCheckBox()
void	setCheckBoxEnabled(boolean enabled)
void	setTooltipText(java.lang.String text, Composite parent) Sets the tooltip on the checkbox and the label.

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanTooltipFieldEditor

protected BooleanTooltipFieldEditor()

Default constructor.

BooleanTooltipFieldEditor

public BooleanTooltipFieldEditor(java.lang.String name,
                                 java.lang.String label,
                                 java.lang.String tooltip,
                                 Composite parent)

Creates a boolean field editor in the default style.

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

BooleanTooltipFieldEditor

public BooleanTooltipFieldEditor(java.lang.String name,
                                 java.lang.String labelText,
                                 java.lang.String tooltip,
                                 int style,
                                 Composite parent)

Creates a boolean field editor in the given style.

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 style, either DEFAULT or SEPARATE_LABEL

parent - the parent of the field editor's control

See Also:

#DEFAULT, #SEPARATE_LABEL

Method Detail

setTooltipText

public void setTooltipText(java.lang.String text,
                           Composite parent)

Sets the tooltip on the checkbox and the label.

Parameters:

text - The tooltip text to be used

parent - The editors parent Composite

setCheckBoxEnabled

public void setCheckBoxEnabled(boolean enabled)

Parameters:

enabled - true to enable the check box, false to disable it.

getCheckBox

public Button getCheckBox()

Returns:

The check box.