net.enilink.commons.ui.editor

Class EditorWidgetFactory

java.lang.Object

net.enilink.commons.ui.editor.EditorWidgetFactory

public class EditorWidgetFactory
extends Object

A FormToolkit customized for use by editor components.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_DRAW_BORDER
static String	TEXT_BORDER
protected org.eclipse.ui.forms.widgets.FormToolkit	toolkit
static String	TREE_BORDER

Constructor Summary

Constructors

Constructor and Description
EditorWidgetFactory(org.eclipse.swt.widgets.Display display)
EditorWidgetFactory(org.eclipse.ui.forms.FormColors colors)
EditorWidgetFactory(org.eclipse.ui.forms.widgets.FormToolkit toolkit)

Method Summary

Modifier and Type	Method and Description
void	adapt(org.eclipse.swt.widgets.Composite composite) Adapts a composite to be used in a form associated with this toolkit.
void	adapt(org.eclipse.swt.widgets.Control control, boolean trackFocus, boolean trackKeyboard) Adapts a control to be used in a form that is associated with this toolkit.
org.eclipse.swt.widgets.Button	createButton(org.eclipse.swt.widgets.Composite parent, String text, int style) Creates a button as a part of the form.
org.eclipse.swt.custom.CCombo	createCCombo(org.eclipse.swt.widgets.Composite parent) Creates a combo box as a part of the form.
org.eclipse.swt.custom.CCombo	createCCombo(org.eclipse.swt.widgets.Composite parent, int comboStyle) Creates a combo box as a part of the form.
org.eclipse.swt.custom.CLabel	createCLabel(org.eclipse.swt.widgets.Composite parent, String text) Creates a label as a part of the form.
org.eclipse.swt.custom.CLabel	createCLabel(org.eclipse.swt.widgets.Composite parent, String text, int style) Creates a label as a part of the form.
org.eclipse.swt.widgets.Composite	createComposite(org.eclipse.swt.widgets.Composite parent) Creates the composite as a part of the form.
org.eclipse.swt.widgets.Composite	createComposite(org.eclipse.swt.widgets.Composite parent, int style) Creates the composite as part of the form using the provided style.
org.eclipse.swt.widgets.Composite	createCompositeSeparator(org.eclipse.swt.widgets.Composite parent) Creats the composite that can server as a separator between various parts of a form.
org.eclipse.ui.forms.widgets.ExpandableComposite	createExpandableComposite(org.eclipse.swt.widgets.Composite parent, int expansionStyle) Creates an expandable composite as a part of the form.
org.eclipse.swt.widgets.Composite	createFlatFormComposite(org.eclipse.swt.widgets.Composite parent) Creates a flat form composite as a part of the form.
org.eclipse.ui.forms.widgets.Form	createForm(org.eclipse.swt.widgets.Composite parent) Creates a form widget in the provided parent.
org.eclipse.ui.forms.widgets.FormText	createFormText(org.eclipse.swt.widgets.Composite parent, boolean trackFocus) Creates a rich text as a part of the form.
org.eclipse.swt.widgets.Group	createGroup(org.eclipse.swt.widgets.Composite parent, String text) Creates a group as a part of the form.
org.eclipse.ui.forms.widgets.Hyperlink	createHyperlink(org.eclipse.swt.widgets.Composite parent, String text, int style) Creates a hyperlink as a part of the form.
org.eclipse.ui.forms.widgets.ImageHyperlink	createImageHyperlink(org.eclipse.swt.widgets.Composite parent, int style) Creates an image hyperlink as a part of the form.
org.eclipse.swt.widgets.Label	createLabel(org.eclipse.swt.widgets.Composite parent, String text) Creates a label as a part of the form.
org.eclipse.swt.widgets.Label	createLabel(org.eclipse.swt.widgets.Composite parent, String text, int style) Creates a label as a part of the form.
org.eclipse.swt.widgets.List	createList(org.eclipse.swt.widgets.Composite parent, int style) Creates the list as a part of the form.
PageBook	createPageBook(org.eclipse.swt.widgets.Composite parent, int style) Creates a page book widget as a part of the form.
org.eclipse.swt.widgets.Composite	createPlainComposite(org.eclipse.swt.widgets.Composite parent, int style) Creates a plain composite as a part of the form.
org.eclipse.swt.custom.ScrolledComposite	createScrolledComposite(org.eclipse.swt.widgets.Composite parent, int style) Creates a scrolled composite as a part of the form.
org.eclipse.ui.forms.widgets.ScrolledForm	createScrolledForm(org.eclipse.swt.widgets.Composite parent) Creates a scrolled form widget in the provided parent.
org.eclipse.ui.forms.widgets.ScrolledPageBook	createScrolledPageBook(org.eclipse.swt.widgets.Composite parent, int style) Creates a scrolled page book widget as a part of the form.
org.eclipse.ui.forms.widgets.Section	createSection(org.eclipse.swt.widgets.Composite parent, int sectionStyle) Creates a section as a part of the form.
org.eclipse.swt.widgets.Label	createSeparator(org.eclipse.swt.widgets.Composite parent, int style) Creates a separator label as a part of the form.
org.eclipse.swt.custom.CTabFolder	createTabFolder(org.eclipse.swt.widgets.Composite parent, int style) Creates the tab folder as a part of the form.
org.eclipse.swt.custom.CTabItem	createTabItem(org.eclipse.swt.custom.CTabFolder tabFolder, int style) Creates the tab item as a part of the tab folder.
org.eclipse.swt.widgets.Table	createTable(org.eclipse.swt.widgets.Composite parent, int style) Creates a table as a part of the form.
org.eclipse.swt.widgets.Text	createText(org.eclipse.swt.widgets.Composite parent, String value) Creates a text as a part of the form.
org.eclipse.swt.widgets.Text	createText(org.eclipse.swt.widgets.Composite parent, String value, int style) Creates a text as a part of the form.
org.eclipse.swt.widgets.Tree	createTree(org.eclipse.swt.widgets.Composite parent, int style) Creates a tree widget as a part of the form.
void	decorateFormHeading(org.eclipse.ui.forms.widgets.Form form) Takes advantage of the gradients and other capabilities to decorate the form heading using colors computed based on the current skin and operating system.
void	dispose()
int	getBorderMargin() Returns the margin required around the children whose border is being painted by the toolkit using paintBordersFor(Composite).
int	getBorderStyle() Returns the border style used for various widgets created by this toolkit.
org.eclipse.ui.forms.FormColors	getColors() Returns the colors used by this toolkit.
org.eclipse.ui.forms.HyperlinkGroup	getHyperlinkGroup() Returns the hyperlink group that manages hyperlinks for this toolkit.
int	getOrientation() Returns the orientation that all the widgets created by this toolkit will inherit, if set.
void	paintBordersFor(org.eclipse.swt.widgets.Composite parent) Paints flat borders for widgets created by this toolkit within the provided parent.
void	refreshHyperlinkColors() Refreshes the hyperlink colors by loading from JFace settings.
void	setBackground(org.eclipse.swt.graphics.Color bg) Sets the background color for the entire toolkit.
void	setBorderStyle(int style) Sets the border style to be used when creating widgets.
void	setOrientation(int orientation) Sets the orientation that all the widgets created by this toolkit will inherit.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DRAW_BORDER

public static final String KEY_DRAW_BORDER

See Also:

Constant Field Values

TREE_BORDER

public static final String TREE_BORDER

See Also:

Constant Field Values

TEXT_BORDER

public static final String TEXT_BORDER

See Also:

Constant Field Values

toolkit

protected org.eclipse.ui.forms.widgets.FormToolkit toolkit

Constructor Detail

EditorWidgetFactory

public EditorWidgetFactory(org.eclipse.swt.widgets.Display display)

EditorWidgetFactory

public EditorWidgetFactory(org.eclipse.ui.forms.widgets.FormToolkit toolkit)

EditorWidgetFactory

public EditorWidgetFactory(org.eclipse.ui.forms.FormColors colors)

Method Detail

createTabFolder

public org.eclipse.swt.custom.CTabFolder createTabFolder(org.eclipse.swt.widgets.Composite parent,
                                                         int style)

Creates the tab folder as a part of the form.

Parameters:

parent - the composite parent.

style - the tab folder style.

Returns:

the tab folder

createTabItem

public org.eclipse.swt.custom.CTabItem createTabItem(org.eclipse.swt.custom.CTabFolder tabFolder,
                                                     int style)

Creates the tab item as a part of the tab folder.

Parameters:

tabFolder - the parent.

style - the tab folder style.

Returns:

the tab item.

createList

public org.eclipse.swt.widgets.List createList(org.eclipse.swt.widgets.Composite parent,
                                               int style)

Creates the list as a part of the form.

Parameters:

parent - the composite parent.

style - the list style.

Returns:

the list.

createComposite

public org.eclipse.swt.widgets.Composite createComposite(org.eclipse.swt.widgets.Composite parent,
                                                         int style)

Creates the composite as part of the form using the provided style.

Parameters:

parent - the composite parent

style - the composite style

Returns:

the composite widget

createComposite

public org.eclipse.swt.widgets.Composite createComposite(org.eclipse.swt.widgets.Composite parent)

Creates the composite as a part of the form.

Parameters:

parent - the composite parent

Returns:

the composite widget

createPlainComposite

public org.eclipse.swt.widgets.Composite createPlainComposite(org.eclipse.swt.widgets.Composite parent,
                                                              int style)

Creates a plain composite as a part of the form.

Parameters:

parent - the composite parent.

style - the composite style.

Returns:

the composite.

createScrolledComposite

public org.eclipse.swt.custom.ScrolledComposite createScrolledComposite(org.eclipse.swt.widgets.Composite parent,
                                                                        int style)

Creates a scrolled composite as a part of the form.

Parameters:

parent - the composite parent.

style - the composite style.

Returns:

the composite.

createCCombo

public org.eclipse.swt.custom.CCombo createCCombo(org.eclipse.swt.widgets.Composite parent,
                                                  int comboStyle)

Creates a combo box as a part of the form.

Parameters:

parent - the combo box parent.

comboStyle - the combo box style.

Returns:

the combo box.

createCCombo

public org.eclipse.swt.custom.CCombo createCCombo(org.eclipse.swt.widgets.Composite parent)

Creates a combo box as a part of the form.

Parameters:

parent - the combo box parent.

Returns:

the combo box.

createGroup

public org.eclipse.swt.widgets.Group createGroup(org.eclipse.swt.widgets.Composite parent,
                                                 String text)

Creates a group as a part of the form.

Parameters:

parent - the group parent.

text - the group title.

Returns:

the composite.

createFlatFormComposite

public org.eclipse.swt.widgets.Composite createFlatFormComposite(org.eclipse.swt.widgets.Composite parent)

Creates a flat form composite as a part of the form.

Parameters:

parent - the composite parent.

Returns:

the composite.

createCLabel

public org.eclipse.swt.custom.CLabel createCLabel(org.eclipse.swt.widgets.Composite parent,
                                                  String text)

Creates a label as a part of the form.

Parameters:

parent - the label parent.

text - the label text.

Returns:

the label.

createCLabel

public org.eclipse.swt.custom.CLabel createCLabel(org.eclipse.swt.widgets.Composite parent,
                                                  String text,
                                                  int style)

Creates a label as a part of the form.

Parameters:

parent - the label parent.

text - the label text.

style - the label style.

Returns:

the label.

createPageBook

public PageBook createPageBook(org.eclipse.swt.widgets.Composite parent,
                               int style)

Creates a page book widget as a part of the form.

Parameters:

parent - the page book parent

style - the text style

Returns:

the page book widget

dispose

public void dispose()

createButton

public org.eclipse.swt.widgets.Button createButton(org.eclipse.swt.widgets.Composite parent,
                                                   String text,
                                                   int style)

Creates a button as a part of the form.

Parameters:

parent - the button parent

text - an optional text for the button (can be null)

style - the button style (for example, SWT.PUSH)

Returns:

the button widget

createCompositeSeparator

public org.eclipse.swt.widgets.Composite createCompositeSeparator(org.eclipse.swt.widgets.Composite parent)

Creats the composite that can server as a separator between various parts of a form. Separator height should be controlled by setting the height hint on the layout data for the composite.

Parameters:

parent - the separator parent

Returns:

the separator widget

createLabel

public org.eclipse.swt.widgets.Label createLabel(org.eclipse.swt.widgets.Composite parent,
                                                 String text)

Creates a label as a part of the form.

Parameters:

parent - the label parent

text - the label text

Returns:

the label widget

createLabel

public org.eclipse.swt.widgets.Label createLabel(org.eclipse.swt.widgets.Composite parent,
                                                 String text,
                                                 int style)

Creates a label as a part of the form.

Parameters:

parent - the label parent

text - the label text

style - the label style

Returns:

the label widget

createHyperlink

public org.eclipse.ui.forms.widgets.Hyperlink createHyperlink(org.eclipse.swt.widgets.Composite parent,
                                                              String text,
                                                              int style)

Creates a hyperlink as a part of the form. The hyperlink will be added to the hyperlink group that belongs to this toolkit.

Parameters:

parent - the hyperlink parent

text - the text of the hyperlink

style - the hyperlink style

Returns:

the hyperlink widget

createImageHyperlink

public org.eclipse.ui.forms.widgets.ImageHyperlink createImageHyperlink(org.eclipse.swt.widgets.Composite parent,
                                                                        int style)

Creates an image hyperlink as a part of the form. The hyperlink will be added to the hyperlink group that belongs to this toolkit.

Parameters:

parent - the hyperlink parent

style - the hyperlink style

Returns:

the image hyperlink widget

createFormText

public org.eclipse.ui.forms.widgets.FormText createFormText(org.eclipse.swt.widgets.Composite parent,
                                                            boolean trackFocus)

Creates a rich text as a part of the form.

Parameters:

parent - the rich text parent

trackFocus - if true, the toolkit will monitor focus transfers to ensure that the hyperlink in focus is visible in the form.

Returns:

the rich text widget

adapt

public void adapt(org.eclipse.swt.widgets.Control control,
                  boolean trackFocus,
                  boolean trackKeyboard)

Adapts a control to be used in a form that is associated with this toolkit. This involves adjusting colors and optionally adding handlers to ensure focus tracking and keyboard management.

Parameters:

control - a control to adapt

trackFocus - if true, form will be scrolled horizontally and/or vertically if needed to ensure that the control is visible when it gains focus. Set it to false if the control is not capable of gaining focus.

trackKeyboard - if true, the control that is capable of gaining focus will be tracked for certain keys that are important to the underlying form (for example, PageUp, PageDown, ScrollUp, ScrollDown etc.). Set it to false if the control is not capable of gaining focus or these particular key event are already used by the control.

adapt

public void adapt(org.eclipse.swt.widgets.Composite composite)

Adapts a composite to be used in a form associated with this toolkit.

Parameters:

composite - the composite to adapt

createSection

public org.eclipse.ui.forms.widgets.Section createSection(org.eclipse.swt.widgets.Composite parent,
                                                          int sectionStyle)

Creates a section as a part of the form.

Parameters:

parent - the section parent

sectionStyle - the section style

Returns:

the section widget

createExpandableComposite

public org.eclipse.ui.forms.widgets.ExpandableComposite createExpandableComposite(org.eclipse.swt.widgets.Composite parent,
                                                                                  int expansionStyle)

Creates an expandable composite as a part of the form.

Parameters:

parent - the expandable composite parent

expansionStyle - the expandable composite style

Returns:

the expandable composite widget

createSeparator

public org.eclipse.swt.widgets.Label createSeparator(org.eclipse.swt.widgets.Composite parent,
                                                     int style)

Creates a separator label as a part of the form.

Parameters:

parent - the separator parent

style - the separator style

Returns:

the separator label

createTable

public org.eclipse.swt.widgets.Table createTable(org.eclipse.swt.widgets.Composite parent,
                                                 int style)

Creates a table as a part of the form.

Parameters:

parent - the table parent

style - the table style

Returns:

the table widget

createText

public org.eclipse.swt.widgets.Text createText(org.eclipse.swt.widgets.Composite parent,
                                               String value)

Creates a text as a part of the form.

Parameters:

parent - the text parent

value - the text initial value

Returns:

the text widget

createText

public org.eclipse.swt.widgets.Text createText(org.eclipse.swt.widgets.Composite parent,
                                               String value,
                                               int style)

Creates a text as a part of the form.

Parameters:

parent - the text parent

value - the text initial value

style - the text style

Returns:

the text widget

createTree

public org.eclipse.swt.widgets.Tree createTree(org.eclipse.swt.widgets.Composite parent,
                                               int style)

Creates a tree widget as a part of the form.

Parameters:

parent - the tree parent

style - the tree style

Returns:

the tree widget

createScrolledForm

public org.eclipse.ui.forms.widgets.ScrolledForm createScrolledForm(org.eclipse.swt.widgets.Composite parent)

Creates a scrolled form widget in the provided parent. If you do not require scrolling because there is already a scrolled composite up the parent chain, use 'createForm' instead.

Parameters:

parent - the scrolled form parent

Returns:

the form that can scroll itself

See Also:

createForm(org.eclipse.swt.widgets.Composite)

createForm

public org.eclipse.ui.forms.widgets.Form createForm(org.eclipse.swt.widgets.Composite parent)

Creates a form widget in the provided parent. Note that this widget does not scroll its content, so make sure there is a scrolled composite up the parent chain. If you require scrolling, use 'createScrolledForm' instead.

Parameters:

parent - the form parent

Returns:

the form that does not scroll

See Also:

createScrolledForm(org.eclipse.swt.widgets.Composite)

decorateFormHeading

public void decorateFormHeading(org.eclipse.ui.forms.widgets.Form form)

Takes advantage of the gradients and other capabilities to decorate the form heading using colors computed based on the current skin and operating system.

Parameters:

form - the form to decorate

createScrolledPageBook

public org.eclipse.ui.forms.widgets.ScrolledPageBook createScrolledPageBook(org.eclipse.swt.widgets.Composite parent,
                                                                            int style)

Creates a scrolled page book widget as a part of the form.

Parameters:

parent - the page book parent

style - the text style

Returns:

the scrolled page book widget

getHyperlinkGroup

public org.eclipse.ui.forms.HyperlinkGroup getHyperlinkGroup()

Returns the hyperlink group that manages hyperlinks for this toolkit.

Returns:

the hyperlink group

setBackground

public void setBackground(org.eclipse.swt.graphics.Color bg)

Sets the background color for the entire toolkit. The method delegates the call to the FormColors object and also updates the hyperlink group so that hyperlinks and other objects are in sync.

Parameters:

bg - the new background color

refreshHyperlinkColors

public void refreshHyperlinkColors()

Refreshes the hyperlink colors by loading from JFace settings.

paintBordersFor

public void paintBordersFor(org.eclipse.swt.widgets.Composite parent)

Paints flat borders for widgets created by this toolkit within the provided parent. Borders will not be painted if the global border style is SWT.BORDER (i.e. if native borders are used). Call this method during creation of a form composite to get the borders of its children painted. Care should be taken when selection layout margins. At least one pixel pargin width and height must be chosen to allow the toolkit to paint the border on the parent around the widgets.

Borders are painted for some controls that are selected by the toolkit by default. If a control needs a border but is not on its list, it is possible to force border in the following way:

 
 
 
             widget.setData(FormToolkit.KEY_DRAW_BORDER, FormToolkit.TREE_BORDER);
             
             or
             
             widget.setData(FormToolkit.KEY_DRAW_BORDER, FormToolkit.TEXT_BORDER);
 
 
 
 

Parameters:

parent - the parent that owns the children for which the border needs to be painted.

getColors

public org.eclipse.ui.forms.FormColors getColors()

Returns the colors used by this toolkit.

Returns:

the color object

getBorderStyle

public int getBorderStyle()

Returns the border style used for various widgets created by this toolkit. The intent of the toolkit is to create controls with styles that yield a 'flat' appearance. On systems where the native borders are already flat, we set the style to SWT.BORDER and don't paint the borders ourselves. Otherwise, the style is set to SWT.NULL, and borders are painted by the toolkit.

Returns:

the global border style

getBorderMargin

public int getBorderMargin()

Returns the margin required around the children whose border is being painted by the toolkit using paintBordersFor(Composite). Since the border is painted around the controls on the parent, a number of pixels needs to be reserved for this border. For windowing systems where the native border is used, this margin is 0.

Returns:

the margin in the parent when children have their border painted

setBorderStyle

public void setBorderStyle(int style)

Sets the border style to be used when creating widgets. The toolkit chooses the correct style based on the platform but this value can be changed using this method.

Parameters:

style - SWT.BORDER or SWT.NULL

See Also:

getBorderStyle()

getOrientation

public int getOrientation()

Returns the orientation that all the widgets created by this toolkit will inherit, if set. Can be SWT.NULL, SWT.LEFT_TO_RIGHT and SWT.RIGHT_TO_LEFT.

Returns:

orientation style for this toolkit, or SWT.NULL if not set. The default orientation is inherited from the Window default orientation.

See Also:

Window.getDefaultOrientation()

setOrientation

public void setOrientation(int orientation)

Sets the orientation that all the widgets created by this toolkit will inherit. Can be SWT.NULL, SWT.LEFT_TO_RIGHT and SWT.RIGHT_TO_LEFT.

Parameters:

orientation - style for this toolkit.