org.povclipse2.tools.swt.editor

Class HelpLinkColorTooltipFieldEditor

java.lang.Object

ColorFieldEditor

org.povclipse2.tools.swt.editor.ColorTooltipFieldEditor

org.povclipse2.tools.swt.editor.HelpLinkColorTooltipFieldEditor

public class HelpLinkColorTooltipFieldEditor
extends ColorTooltipFieldEditor

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

Author:

Wolfgang Möstl

Constructor Summary

Constructors

Constructor and Description
HelpLinkColorTooltipFieldEditor() Default constructor
HelpLinkColorTooltipFieldEditor(java.lang.String name, java.lang.String labelText, java.lang.String tooltip, Composite parent, java.lang.String helpURL, java.lang.String helpImageTooltip) Constructor setting all parameters
HelpLinkColorTooltipFieldEditor(java.lang.String name, java.lang.String labelText, java.lang.String tooltip, Composite parent, java.lang.String helpURL, java.lang.String helpImageTooltip, boolean showHelpLink) 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.ColorTooltipFieldEditor

getButton, setButtonEnabled, setTooltipText

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpLinkColorTooltipFieldEditor

public HelpLinkColorTooltipFieldEditor()

Default constructor

HelpLinkColorTooltipFieldEditor

public HelpLinkColorTooltipFieldEditor(java.lang.String name,
                                       java.lang.String labelText,
                                       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

labelText - the label text of the field editor

tooltip - the tooltip to be displayed on the editor item 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

HelpLinkColorTooltipFieldEditor

public HelpLinkColorTooltipFieldEditor(java.lang.String name,
                                       java.lang.String labelText,
                                       java.lang.String tooltip,
                                       Composite parent,
                                       java.lang.String helpURL,
                                       java.lang.String helpImageTooltip,
                                       boolean showHelpLink)

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 editor item 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

showHelpLink - true to show the help link (default), false to hide it. Use hiding if there are other HelpLink editors and you do not want to show a help link icon for this editor in order to prevent layout issues.

Method Detail

doFillIntoGrid

protected void doFillIntoGrid(Composite parent,
                              int numColumns)

See Also:

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

getNumberOfControls

public int getNumberOfControls()

See Also:

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

adjustForNumColumns

protected void adjustForNumColumns(int numColumns)

See Also:

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

setEnabled

public void setEnabled(boolean enabled,
                       Composite parent)

See Also:

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