org.eclipse.sphinx.platform.ui.internal.util

Class LayoutUtil

java.lang.Object

org.eclipse.sphinx.platform.ui.internal.util.LayoutUtil

public class LayoutUtil
extends java.lang.Object

UI Layout Utility

Provides utility methods to set parameters of UI layouts.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_WITDH The maximum width allowed for this field.

Constructor Summary

Constructors

Constructor and Description
LayoutUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static org.eclipse.swt.layout.GridData	gridDataForButton(org.eclipse.swt.widgets.Button button, int span) Creates a GridData for the specified button widget.
static org.eclipse.swt.layout.GridData	gridDataForButtons(int span)
static org.eclipse.swt.layout.GridData	gridDataForCCombo(int span)
static org.eclipse.swt.layout.GridData	gridDataForCombo(int span)
static org.eclipse.swt.layout.GridData	gridDataForLabel(int span)
static org.eclipse.swt.layout.GridData	gridDataForLabel(int span, boolean multiLine)
static org.eclipse.swt.layout.GridData	gridDataForList(int span, PixelConverter converter)
static org.eclipse.swt.layout.GridData	gridDataForSeperator(int span, int height)
static org.eclipse.swt.layout.GridData	gridDataForSpecificComposite(int span) Convenient method for creating a GridData dedicated to a specific composite (e.g.
static org.eclipse.swt.layout.GridData	gridDataForSpecificComposite(int span, boolean hgrab, boolean vgrab) Convenient method for creating a GridData dedicated to a specific composite (e.g.
static org.eclipse.swt.layout.GridData	gridDataForText(int span)
static org.eclipse.swt.layout.GridLayout	gridLayoutForSpecificComposite(int numColumns) Convenient method for creating a GridLayout dedicated to a specific composite (e.g.
static void	setHorizontalGrabbing(org.eclipse.swt.widgets.Control control) Sets the horizontal grabbing of a control to true.
static void	setHorizontalSpan(org.eclipse.swt.widgets.Control control, int span) Sets the span of a control.
static void	setWidthHint(org.eclipse.swt.widgets.Control control, int widthHint) Sets the width hint of a control.
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForButton(org.eclipse.swt.widgets.Button button, int span) Creates a TableWrapData for the specified button widget.
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForButtons(int span)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForCCombo(int span)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForCombo(int span)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForLabel(int span)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForLabel(int span, boolean multiLine)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForList(int span, PixelConverter converter)
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForSpecificComposite(int span) Convenient method for creating a TableWrapData dedicated to a specific composite (e.g.
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForSpecificComposite(int span, boolean hgrab, boolean vgrab) Convenient method for creating a TableWrapData dedicated to a specific composite (e.g.
static org.eclipse.ui.forms.widgets.TableWrapData	tableWrapDataForText(int span)
static org.eclipse.ui.forms.widgets.TableWrapLayout	tableWrapLayoutForSpecificComposite(int numColumns) Convenient method for creating a TableWrapLayout dedicated to a specific composite (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_WITDH

protected static final int MAX_WITDH

The maximum width allowed for this field.

See Also:

Constant Field Values

Constructor Detail

LayoutUtil

public LayoutUtil()

Method Detail

setWidthHint

public static void setWidthHint(org.eclipse.swt.widgets.Control control,
                int widthHint)

Sets the width hint of a control. Assumes that GridData is used.

setHorizontalGrabbing

public static void setHorizontalGrabbing(org.eclipse.swt.widgets.Control control)

Sets the horizontal grabbing of a control to true. Assumes that GridData is used.

setHorizontalSpan

public static void setHorizontalSpan(org.eclipse.swt.widgets.Control control,
                     int span)

Sets the span of a control. Assumes that GridData is used.

gridDataForCombo

public static final org.eclipse.swt.layout.GridData gridDataForCombo(int span)

tableWrapDataForCombo

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForCombo(int span)

gridDataForCCombo

public static final org.eclipse.swt.layout.GridData gridDataForCCombo(int span)

tableWrapDataForCCombo

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForCCombo(int span)

gridDataForButtons

public static final org.eclipse.swt.layout.GridData gridDataForButtons(int span)

tableWrapDataForButtons

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForButtons(int span)

gridDataForButton

public static final org.eclipse.swt.layout.GridData gridDataForButton(org.eclipse.swt.widgets.Button button,
                                                int span)

Creates a GridData for the specified button widget.

This method initializes grid data as follows:

• fills horizontally;
• does not grab horizontal space;
• spans the right number of columns;
• computes the right width if button style is push.

Parameters:

button - The button widget for which a grid data must be created and initialized.

span - The number of columns the button must take up.

Returns:

The created GridData for the specified button, correctly initialized.

tableWrapDataForButton

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForButton(org.eclipse.swt.widgets.Button button,
                                                                int span)

Creates a TableWrapData for the specified button widget.

This method initializes table wrap data as follows:

• fills horizontally;
• does not grab horizontal space;
• spans the right number of columns;
• computes the right width if button style is push.

Parameters:

button - The button widget for which a table wrap data must be created and initialized.

span - The number of columns the button must take up.

Returns:

The created TableWrapData for the specified button, correctly initialized.

gridDataForLabel

public static final org.eclipse.swt.layout.GridData gridDataForLabel(int span)

gridDataForLabel

public static final org.eclipse.swt.layout.GridData gridDataForLabel(int span,
                                               boolean multiLine)

tableWrapDataForLabel

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForLabel(int span)

tableWrapDataForLabel

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForLabel(int span,
                                                               boolean multiLine)

gridDataForList

public static final org.eclipse.swt.layout.GridData gridDataForList(int span,
                                              PixelConverter converter)

tableWrapDataForList

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForList(int span,
                                                              PixelConverter converter)

gridDataForText

public static final org.eclipse.swt.layout.GridData gridDataForText(int span)

tableWrapDataForText

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForText(int span)

gridDataForSeperator

public static final org.eclipse.swt.layout.GridData gridDataForSeperator(int span,
                                                   int height)

gridDataForSpecificComposite

public static final org.eclipse.swt.layout.GridData gridDataForSpecificComposite(int span)

Convenient method for creating a GridData dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

span - The number of column the composite (for which the grid data is created) will take up.

Returns:

The grid data to use for a specific composite.

gridDataForSpecificComposite

public static final org.eclipse.swt.layout.GridData gridDataForSpecificComposite(int span,
                                                           boolean hgrab,
                                                           boolean vgrab)

Convenient method for creating a GridData dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

span - The number of column the composite (for which the grid data is created) will take up.

hgrab - Flag indicating whether composite (for which the grid data is created) should be made wide enough to fit the remaining horizontal space.

vgrab - Flag indicating whether composite (for which the grid data is created) should be made wide enough to fit the remaining vertical space.

Returns:

The grid data to use for a specific composite.

gridLayoutForSpecificComposite

public static final org.eclipse.swt.layout.GridLayout gridLayoutForSpecificComposite(int numColumns)

Convenient method for creating a GridLayout dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

numColumns - The number of columns in the layout.

Returns:

The grid layout to use for a specific composite, with the right number of columns.

tableWrapDataForSpecificComposite

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForSpecificComposite(int span)

Convenient method for creating a TableWrapData dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

span - The number of columns the composite (for which the table wrap data is created) will take up.

Returns:

The table wrap data to use for a specific composite.

tableWrapDataForSpecificComposite

public static final org.eclipse.ui.forms.widgets.TableWrapData tableWrapDataForSpecificComposite(int span,
                                                                           boolean hgrab,
                                                                           boolean vgrab)

Convenient method for creating a TableWrapData dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

span - The number of columns the composite (for which the table wrap data is created) will take up.

hgrab - Flag indicating whether composite (for which the table wrap data is created) should be made wide enough to fit the remaining horizontal space.

vgrab - Flag indicating whether composite (for which the table wrap data is created) should be made wide enough to fit the remaining vertical space.

Returns:

The table wrap data to use for a specific composite.

tableWrapLayoutForSpecificComposite

public static final org.eclipse.ui.forms.widgets.TableWrapLayout tableWrapLayoutForSpecificComposite(int numColumns)

Convenient method for creating a TableWrapLayout dedicated to a specific composite (e.g. for list button field or string button field).

Parameters:

numColumns - The number of columns in the layout.

Returns:

The table wrap layout to use for a specific composite, with the right number of columns.