org.eclipse.emf.ecp.view.spi.swt.layout

Class LayoutProviderHelper

java.lang.Object

org.eclipse.emf.ecp.view.spi.swt.layout.LayoutProviderHelper

public final class LayoutProviderHelper
extends Object

The helper class allowing an easy access to LayoutProviders.

Since:

1.3

Author:

Eugen Neufeld

Method Summary

Modifier and Type	Method and Description
static void	addLayoutProvider(LayoutProvider layoutProvider) Allows to add a LayoutProvider directly.
static org.eclipse.swt.widgets.Layout	getColumnLayout(int numColumns, boolean equalWidth) Eases the access to the layout provider extension point.
static org.eclipse.swt.widgets.Layout	getColumnLayout(int numColumns, boolean equalWidth, org.eclipse.swt.graphics.Point margins) Eases the access to the layout provider extension point.
static Object	getLayoutData(SWTGridCell gridCell, SWTGridDescription controlGridDescription, SWTGridDescription currentRowGridDescription, SWTGridDescription fullGridDescription, VElement vElement, org.eclipse.emf.ecore.EObject domainModel, org.eclipse.swt.widgets.Control control) Eases the access to the layout provider extension point.
static Object	getSpanningLayoutData(int spanX, int spanY) The layout data for a spanning layout.

Methods inherited from class java.lang.Object

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

Method Detail

getColumnLayout

public static org.eclipse.swt.widgets.Layout getColumnLayout(int numColumns,
                                                             boolean equalWidth)

Eases the access to the layout provider extension point. For the method description.

Parameters:

numColumns - the number of columns to create

equalWidth - whether the columns should be equal width

Returns:

the layout to use

See Also:

LayoutProvider.getColumnLayout(int, boolean)

getColumnLayout

public static org.eclipse.swt.widgets.Layout getColumnLayout(int numColumns,
                                                             boolean equalWidth,
                                                             org.eclipse.swt.graphics.Point margins)

Eases the access to the layout provider extension point. For the method description.

Parameters:

numColumns - the number of columns to create

equalWidth - whether the columns should be equal width

margins - the margins

Returns:

the layout to use

Since:

1.7

See Also:

LayoutProvider.getColumnLayout(int, boolean, Point)

getLayoutData

public static Object getLayoutData(SWTGridCell gridCell,
                                   SWTGridDescription controlGridDescription,
                                   SWTGridDescription currentRowGridDescription,
                                   SWTGridDescription fullGridDescription,
                                   VElement vElement,
                                   org.eclipse.emf.ecore.EObject domainModel,
                                   org.eclipse.swt.widgets.Control control)

Eases the access to the layout provider extension point. For the method description.

Parameters:

gridCell - the current SWTGridCell

controlGridDescription - the SWTGridDescription of the rendered VElement

currentRowGridDescription - the SWTGridDescription of the current row

fullGridDescription - the SWTGridDescription of the whole container

vElement - the VElement which is currently rendered

domainModel - The domain model object whose feature is currently rendered

control - the rendered Control

Returns:

the Object being the layout data to set

Since:

1.6

See Also:

LayoutProvider.getLayoutData(SWTGridCell, SWTGridDescription, SWTGridDescription, SWTGridDescription, VElement, EObject, Control)

getSpanningLayoutData

public static Object getSpanningLayoutData(int spanX,
                                           int spanY)

The layout data for a spanning layout.

Parameters:

spanX - the horizontal span

spanY - the vertical span

Returns:

a simple spanning layout

addLayoutProvider

public static void addLayoutProvider(LayoutProvider layoutProvider)

Allows to add a LayoutProvider directly.

Parameters:

layoutProvider - The LayoutProvider

Since:

1.6