au.com.cybersearch2.controls

Class ControlFactory

java.lang.Object

au.com.cybersearch2.controls.ControlFactory

public class ControlFactory
extends Object

ControlFactory SWT widget factory and widget support. Isolates aspects of SWT which are not easy to test with Mockito, particularly Widget object construction. Also provides the shell for dialogs which are to be framed by the main window. Note that compatibility for use with StatusBar plugin is ensured by implementing StatusBarControlFactory interface.

Author:

Andrew Bowley 2 Mar 2016

Constructor Summary

Constructors

Constructor and Description
ControlFactory()

Method Summary

Modifier and Type	Method and Description
ButtonBar	buttonBarInstance(org.eclipse.swt.widgets.Composite composite) Returns a buttom bar component for use in a view.
org.eclipse.swt.widgets.Button	buttonInstance(org.eclipse.swt.widgets.Composite composite, int style) Returns button control Instances of this class represent a selectable user interface object that issues notification when pressed and released.
org.eclipse.swt.widgets.Combo	comboInstance(org.eclipse.swt.widgets.Composite composite, int style) Returns combo control Instances of this class are controls that allow the user to choose an item from a list of items, or optionally enter a new value by typing it into an editable text field.
org.eclipse.swt.widgets.Composite	compositeInstance(org.eclipse.swt.widgets.Composite parent) Returns a control which is capable of containing other controls
int	convertHeightInCharsToPixels(org.eclipse.swt.widgets.Composite parent, int count) Use font metrics to convert height is characters to pixels
int	convertHorizontalDLUsToPixels(org.eclipse.swt.graphics.FontMetrics fontMetrics, int dlus) Returns the number of pixels corresponding to the given number of horizontal dialog units.
int	convertVerticalDLUsToPixels(org.eclipse.swt.graphics.FontMetrics fontMetrics, int dlus) Returns the number of pixels corresponding to the given number of vertical dialog units.
<T extends CustomControls> CustomDialog<T>	customDialogInstance(org.eclipse.swt.widgets.Shell activeShell, T customControls, String title) Returns custom dialog with content provided by given custom controls object
<T extends CustomControls> CustomDialog<T>	customDialogInstance(T customControls, String title) Returns custom dialog located in default shell with content provided by given custom controls object
org.eclipse.swt.custom.CLabel	customLabelInstance(org.eclipse.swt.widgets.Composite composite, CustomLabelSpec specification) Returns a label control which supports aligned text and/or an image and different border styles.
org.eclipse.swt.widgets.FileDialog	fileDialogInstance() Returns a dialog to select a file.
DefaultGridData	getDefaultGridData() Returns wrapped default grid data factory.
DefaultLayout	getDefaultLayout() Returns wrapped default layout factory.
org.eclipse.swt.graphics.Font	getDialogFont() Returns the JFace's dialog font.
DialogPixels	getDialogPixels(org.eclipse.swt.widgets.Composite parent) Returns dialog parameters converted to pixels.
org.eclipse.swt.graphics.FontMetrics	getFontMetrics(org.eclipse.swt.widgets.Composite parent) Returns a FontMetrics which contains information about the font currently being used by the receiver to draw and measure text.
org.eclipse.swt.widgets.Group	groupInstance(org.eclipse.swt.widgets.Composite composite, int style) Returns a Group control Instances of this class provide an etched border with an optional title.
org.eclipse.swt.widgets.Label	labelInstance(org.eclipse.swt.widgets.Composite composite, int style) Returns label control Instances of this class represent a non-selectable user interface object that displays a string or image.
StatusItemLayoutData	labelLayoutDataInstance(org.eclipse.swt.custom.CLabel label, CustomLabelSpec specification) Returns status item layout data - hint width and height
org.eclipse.swt.widgets.List	listInstance(org.eclipse.swt.widgets.Composite parent, int style) Returns a List control.
org.eclipse.swt.widgets.Menu	menuInstance(org.eclipse.swt.widgets.Control parent) Returns a detached menu.
org.eclipse.swt.widgets.MenuItem	menuItemInstance(org.eclipse.swt.widgets.Menu parent, int style) Returns a menu item.
org.eclipse.jface.dialogs.ProgressMonitorDialog	progressMonitorDialogInstance() Returns A modal dialog that displays progress during a long running operation.
org.eclipse.swt.widgets.Label	separatorInstance(org.eclipse.swt.widgets.Composite composite) Returns a label control for use as a separator
org.eclipse.swt.widgets.Text	textInstance(org.eclipse.swt.widgets.Composite composite, int style) Returns text control Instances of this class are selectable user interface objects that allow the user to enter and modify text.
org.eclipse.swt.widgets.ToolTip	toolTipInstance(org.eclipse.swt.widgets.Composite parent) Returns tool tip object bound to specified parent's shell
org.eclipse.jface.viewers.TreeViewer	treeViewerInstance(org.eclipse.swt.widgets.Composite parent, int style) Return a tree viewer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlFactory

public ControlFactory()

Method Detail

customDialogInstance

public <T extends CustomControls> CustomDialog<T> customDialogInstance(org.eclipse.swt.widgets.Shell activeShell,
                                                                       T customControls,
                                                                       String title)

Returns custom dialog with content provided by given custom controls object

Parameters:

activeShell - Currently active shell or null if default shell to be used

customControls - Custom controls of specified generic type

title - Dialog title

Returns:

CustomDialog object

customDialogInstance

public <T extends CustomControls> CustomDialog<T> customDialogInstance(T customControls,
                                                                       String title)

Returns custom dialog located in default shell with content provided by given custom controls object

Parameters:

customControls - Custom controls of specified generic type

title - Dialog title

Returns:

CustomDialog object

progressMonitorDialogInstance

public org.eclipse.jface.dialogs.ProgressMonitorDialog progressMonitorDialogInstance()

Returns A modal dialog that displays progress during a long running operation. It is located in the default shell.

Returns:

ProgressMonitorDialog object

compositeInstance

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

Returns a control which is capable of containing other controls

Parameters:

parent - Parent composite

comboInstance

public org.eclipse.swt.widgets.Combo comboInstance(org.eclipse.swt.widgets.Composite composite,
                                                   int style)

Returns combo control Instances of this class are controls that allow the user to choose an item from a list of items, or optionally enter a new value by typing it into an editable text field. Often, Combos are used in the same place where a single selection List widget could be used but space is limited. A Combo takes less space than a List widget and shows similar information.

Styles:

DROP_DOWN, READ_ONLY, SIMPLE

Events:

DefaultSelection, Modify, Selection, Verify, OrientationChange

Note: Only one of the styles DROP_DOWN and SIMPLE may be specified.

Parameters:

composite - Parent composite

style - Style

Returns:

Combo object

textInstance

public org.eclipse.swt.widgets.Text textInstance(org.eclipse.swt.widgets.Composite composite,
                                                 int style)

Returns text control Instances of this class are selectable user interface objects that allow the user to enter and modify text. Text controls can be either single or multi-line. When a text control is created with a border, the operating system includes a platform specific inset around the contents of the control. When created without a border, an effort is made to remove the inset such that the preferred size of the control is the same size as the contents.

Styles:

CENTER, ICON_CANCEL, ICON_SEARCH, LEFT, MULTI, PASSWORD, SEARCH, SINGLE, RIGHT, READ_ONLY, WRAP

Events:

DefaultSelection, Modify, Verify, OrientationChange

Parameters:

composite - Parent composite

style - Style

Returns:

Text object

labelInstance

public org.eclipse.swt.widgets.Label labelInstance(org.eclipse.swt.widgets.Composite composite,
                                                   int style)

Returns label control Instances of this class represent a non-selectable user interface object that displays a string or image.

Styles:

SEPARATOR, HORIZONTAL, VERTICAL

SHADOW_IN, SHADOW_OUT, SHADOW_NONE

CENTER, LEFT, RIGHT, WRAP

Parameters:

composite - Parent composite

style - Style

Returns:

Label object

separatorInstance

public org.eclipse.swt.widgets.Label separatorInstance(org.eclipse.swt.widgets.Composite composite)

Returns a label control for use as a separator

Parameters:

composite - Parent composite

buttonInstance

public org.eclipse.swt.widgets.Button buttonInstance(org.eclipse.swt.widgets.Composite composite,
                                                     int style)

Returns button control Instances of this class represent a selectable user interface object that issues notification when pressed and released.

Styles:

ARROW, CHECK, PUSH, RADIO, TOGGLE, FLAT, WRAP

UP, DOWN, LEFT, RIGHT, CENTER

Events:

Selection

Parameters:

composite - Parent composite

style - Style

Returns:

Button object

buttonBarInstance

public ButtonBar buttonBarInstance(org.eclipse.swt.widgets.Composite composite)

Returns a buttom bar component for use in a view. Based on Dialog button bar implementation, ButtonBar returns a ButtonControl instance when createButton() is called.

Parameters:

composite - Parent composite

Returns:

ButtonBar instance

fileDialogInstance

public org.eclipse.swt.widgets.FileDialog fileDialogInstance()

Returns a dialog to select a file.

Returns:

FileDialog object

listInstance

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

Returns a List control. Instances of this class represent a selectable user interface object that displays a list of strings and issues notification when a string is selected. A list may be single or multi select.

Styles:

SINGLE, MULTI

Events:

Selection, DefaultSelection

Parameters:

parent - a composite control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

groupInstance

public org.eclipse.swt.widgets.Group groupInstance(org.eclipse.swt.widgets.Composite composite,
                                                   int style)

Returns a Group control Instances of this class provide an etched border with an optional title.

Styles:

SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_OUT, SHADOW_NONE

Parameters:

composite - Parent composite

style - Style

customLabelInstance

public org.eclipse.swt.custom.CLabel customLabelInstance(org.eclipse.swt.widgets.Composite composite,
                                                         CustomLabelSpec specification)

Returns a label control which supports aligned text and/or an image and different border styles.

If there is not enough space a CLabel uses the following strategy to fit the information into the available space:

      ignores the indent in left align mode
      ignores the image and the gap
      shortens the text by replacing the center portion of the label with an ellipsis
      shortens the text by removing the center portion of the label
 

Styles:

LEFT, RIGHT, CENTER, SHADOW_IN, SHADOW_OUT, SHADOW_NONE

Parameters:

composite - Parent composite

specification - Custom Label specification

labelLayoutDataInstance

public StatusItemLayoutData labelLayoutDataInstance(org.eclipse.swt.custom.CLabel label,
                                                    CustomLabelSpec specification)

Returns status item layout data - hint width and height

Parameters:

label - Status item Custom Label

specification - Custom Label specification

Returns:

toolTipInstance

public org.eclipse.swt.widgets.ToolTip toolTipInstance(org.eclipse.swt.widgets.Composite parent)

Returns tool tip object bound to specified parent's shell

Parameters:

parent - Parent composite

Returns:

ToolTip object

menuInstance

public org.eclipse.swt.widgets.Menu menuInstance(org.eclipse.swt.widgets.Control parent)

Returns a detached menu. Constructs a new instance of this class given its parent, and sets the style for the instance so that the instance will be a popup menu on the given parent's shell.

After constructing a menu, it can be set into its parent using parent.setMenu(menu). In this case, the parent may be any control in the same widget tree as the parent.

Parameters:

parent - A control which will be the parent of the new instance (cannot be null)

menuItemInstance

public org.eclipse.swt.widgets.MenuItem menuItemInstance(org.eclipse.swt.widgets.Menu parent,
                                                         int style)

Returns a menu item. Constructs a new instance of MenuItem given its parent (which must be a Menu) and a style value describing its behavior and appearance. The item is added to the end of the items maintained by its parent.

Parameters:

parent - a menu control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

treeViewerInstance

public org.eclipse.jface.viewers.TreeViewer treeViewerInstance(org.eclipse.swt.widgets.Composite parent,
                                                               int style)

Return a tree viewer. Creates a tree viewer on a newly-created tree control under the given parent. The tree control is created using the given SWT style bits. The viewer has no input, no content provider, a default label provider, no sorter, and no filters.

Parameters:

parent - Parent control

style - SWT style bits used to create the tree.

getDialogFont

public org.eclipse.swt.graphics.Font getDialogFont()

Returns the JFace's dialog font.

Returns:

Font object

getDialogPixels

public DialogPixels getDialogPixels(org.eclipse.swt.widgets.Composite parent)

Returns dialog parameters converted to pixels.

Parameters:

parent - Parent composite

getFontMetrics

public org.eclipse.swt.graphics.FontMetrics getFontMetrics(org.eclipse.swt.widgets.Composite parent)

Returns a FontMetrics which contains information about the font currently being used by the receiver to draw and measure text.

Parameters:

parent - Parent composite

Returns:

font metrics for the receiver's font

getDefaultLayout

public DefaultLayout getDefaultLayout()

Returns wrapped default layout factory.

Returns:

DefaultLayout object

getDefaultGridData

public DefaultGridData getDefaultGridData()

Returns wrapped default grid data factory.

Returns:

DefaultGridData object

convertHorizontalDLUsToPixels

public int convertHorizontalDLUsToPixels(org.eclipse.swt.graphics.FontMetrics fontMetrics,
                                         int dlus)

Returns the number of pixels corresponding to the given number of horizontal dialog units.

Parameters:

fontMetrics - Used in performing the conversion

dlus - The number of horizontal dialog units

Returns:

the number of pixels

convertVerticalDLUsToPixels

public int convertVerticalDLUsToPixels(org.eclipse.swt.graphics.FontMetrics fontMetrics,
                                       int dlus)

Returns the number of pixels corresponding to the given number of vertical dialog units.

Parameters:

fontMetrics - Used in performing the conversion

dlus - The number of horizontal dialog units

Returns:

the number of pixels

convertHeightInCharsToPixels

public int convertHeightInCharsToPixels(org.eclipse.swt.widgets.Composite parent,
                                        int count)

Use font metrics to convert height is characters to pixels

Parameters:

parent - Composite

count - Character count

Returns:

Number of pixels