Package org.eclipse.emf.ecp.view.spi.compoundcontrol.swt

Class CompoundControlSWTRenderer

java.lang.Object

org.eclipse.emf.ecp.view.model.common.AbstractRenderer<VELEMENT>

org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer<VCompoundControl>

org.eclipse.emf.ecp.view.spi.compoundcontrol.swt.CompoundControlSWTRenderer

public class CompoundControlSWTRenderer
extends AbstractSWTRenderer<VCompoundControl>

AbstractSWTRenderer for the VCompoundControl view model.

Author:

jfaltermeier

Field Summary

Fields inherited from class org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor	Description
CompoundControlSWTRenderer(VCompoundControl vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsLabelProvider labelProvider, EMFFormsRendererFactory rendererFactory, VTViewTemplateProvider viewTemplateProvider, EMFFormsDatabindingEMF databindingService)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected org.eclipse.swt.widgets.Control	createControls(org.eclipse.swt.widgets.Composite parent)	Creates the controls composite.
protected org.eclipse.swt.widgets.Control	createControls(org.eclipse.swt.widgets.Composite parent, int cellsToSkip)	Creates the controls composite.
protected org.eclipse.swt.widgets.Control	createDummyValidationIcon(org.eclipse.swt.widgets.Composite parent)	Creates the validation icon of the first cell of the first child may not be used as the validation icon.
protected org.eclipse.swt.widgets.Control	createLabel(org.eclipse.swt.widgets.Composite parent)	Creates the label composite.
protected org.eclipse.swt.widgets.Control	createValidationIcon(org.eclipse.swt.widgets.Composite parent)	Return the validation cell of the fist child.
protected void	dispose()	Disposes all resources used by the renderer.
protected org.eclipse.swt.widgets.Layout	getColumnLayout(int numColumns, boolean equalWidth)	For testing purposes.
protected org.eclipse.core.databinding.DataBindingContext	getDataBindingContext()	Returns the DataBindingContext.
protected EMFFormsDatabindingEMF	getDatabindingService()
protected java.util.LinkedHashMap<VContainedElement,AbstractSWTRenderer<VElement>>	getElementRendererMap()
SWTGridDescription	getGridDescription(SWTGridDescription gridDescription)	Returns the GridDescription for this Renderer.
protected EMFFormsLabelProvider	getLabelProvider()	Returns the EMFFormsLabelProvider.
protected int	getLabelStyleBits()
protected Optional<java.lang.Integer>	getLabelWidth()
protected java.lang.Object	getLayoutData(SWTGridCell gridCell, SWTGridDescription controlGridDescription, SWTGridDescription currentRowGridDescription, SWTGridDescription fullGridDescription, VElement vElement, org.eclipse.emf.ecore.EObject domainModel, org.eclipse.swt.widgets.Control control)	For testing purposes.
protected EMFFormsRendererFactory	getRendererFactory()	Returns the EMFFormsRendererFactory.
protected java.lang.Object	getSpanningLayoutData(VContainedElement child, int spanX, int spanY)	For testing purposes.
protected VTViewTemplateProvider	getViewTemplateProvider()
protected void	initChildRendererMap()	Initialises the child control to renderer map.
protected org.eclipse.swt.widgets.Control	renderControl(SWTGridCell cell, org.eclipse.swt.widgets.Composite parent)	Renders the passed VElement.
protected void	setFirstControlValidationIconUsed(boolean used)	Whether the first cell of the first child control was used to renderer our validation icon.

Methods inherited from class org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer

applyEnable, applyReadOnly, applyValidation, applyValidation, applyVisible, canReveal, finalizeRendering, getControls, getDefaultFontName, ignoreEnableOnReadOnly, init, isRenderingFinished, postInit, preInit, render, scrollToReveal, scrollToReveal, setControlEnabled

Methods inherited from class org.eclipse.emf.ecp.view.model.common.AbstractRenderer

checkRenderer, getRenderer, getReportService, getVElement, getViewModelContext, register

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundControlSWTRenderer

@Inject
public CompoundControlSWTRenderer(VCompoundControl vElement,
                                  ViewModelContext viewContext,
                                  ReportService reportService,
                                  EMFFormsLabelProvider labelProvider,
                                  EMFFormsRendererFactory rendererFactory,
                                  VTViewTemplateProvider viewTemplateProvider,
                                  EMFFormsDatabindingEMF databindingService)

Default constructor.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

reportService - the ReportService

labelProvider - the label provider

rendererFactory - the renderer factory

viewTemplateProvider - VTViewTemplateProvider

databindingService - EMFFormsDatabindingEMF

Since:

1.17

Method Detail

getLabelProvider

protected EMFFormsLabelProvider getLabelProvider()

Returns the EMFFormsLabelProvider.

Returns:

the label provider

Since:

1.8

getRendererFactory

protected EMFFormsRendererFactory getRendererFactory()

Returns the EMFFormsRendererFactory.

Returns:

the renderer factory

Since:

1.8

getDatabindingService

protected EMFFormsDatabindingEMF getDatabindingService()

Returns:

the EMFFormsDatabindingEMF.

Since:

1.17

getDataBindingContext

protected org.eclipse.core.databinding.DataBindingContext getDataBindingContext()

Returns the DataBindingContext.

Returns:

the databining context

Since:

1.8

getElementRendererMap

protected java.util.LinkedHashMap<VContainedElement,AbstractSWTRenderer<VElement>> getElementRendererMap()

Returns:

child control to renderer map

Since:

1.16

getViewTemplateProvider

protected VTViewTemplateProvider getViewTemplateProvider()

Returns:

the viewTemplateProvider

Since:

1.16

getGridDescription

public SWTGridDescription getGridDescription(SWTGridDescription gridDescription)

Description copied from class: AbstractSWTRenderer

Returns the GridDescription for this Renderer.

Specified by:

getGridDescription in class AbstractSWTRenderer<VCompoundControl>

Parameters:

gridDescription - the current SWTGridDescription

Returns:

the number of controls per row

renderControl

protected org.eclipse.swt.widgets.Control renderControl(SWTGridCell cell,
                                                        org.eclipse.swt.widgets.Composite parent)
                                                 throws NoRendererFoundException,
                                                        NoPropertyDescriptorFoundExeption

Description copied from class: AbstractSWTRenderer

Renders the passed VElement.

Specified by:

renderControl in class AbstractSWTRenderer<VCompoundControl>

Parameters:

cell - the GridCell of the control to render

parent - the Composite to render on

Returns:

the rendered Control

Throws:

NoRendererFoundException - this is thrown when a renderer cannot be found

NoPropertyDescriptorFoundExeption - this is thrown when no property descriptor can be found

createLabel

protected org.eclipse.swt.widgets.Control createLabel(org.eclipse.swt.widgets.Composite parent)

Creates the label composite.

Parameters:

parent - the parent composite

Returns:

the label

Since:

1.8

getLabelStyleBits

protected int getLabelStyleBits()

Returns:

the style bits for the control's label

Since:

1.17

getLabelWidth

protected Optional<java.lang.Integer> getLabelWidth()

Returns:

an optional width for the control's label

Since:

1.16

createValidationIcon

protected org.eclipse.swt.widgets.Control createValidationIcon(org.eclipse.swt.widgets.Composite parent)
                                                        throws NoRendererFoundException,
                                                               NoPropertyDescriptorFoundExeption

Return the validation cell of the fist child. If no children or strange first cell, return a dummy validation icon.

Parameters:

parent - the parent to render on

Returns:

the validation control

Throws:

NoRendererFoundException - this is thrown when a renderer cannot be found

NoPropertyDescriptorFoundExeption - this is thrown when no property descriptor can be found

Since:

1.17

setFirstControlValidationIconUsed

protected void setFirstControlValidationIconUsed(boolean used)

Whether the first cell of the first child control was used to renderer our validation icon.

Parameters:

used - true if used, false otherwise

Since:

1.17

createDummyValidationIcon

protected org.eclipse.swt.widgets.Control createDummyValidationIcon(org.eclipse.swt.widgets.Composite parent)

Creates the validation icon of the first cell of the first child may not be used as the validation icon.

Parameters:

parent - the parent

Returns:

the validation icon

Since:

1.17

createControls

protected org.eclipse.swt.widgets.Control createControls(org.eclipse.swt.widgets.Composite parent)

Creates the controls composite.

Parameters:

parent - the parent composite

Returns:

the controls

Since:

1.8

createControls

protected org.eclipse.swt.widgets.Control createControls(org.eclipse.swt.widgets.Composite parent,
                                                         int cellsToSkip)

Creates the controls composite. May skip the first cell(s).

Parameters:

parent - the parent composite

cellsToSkip - number of cells to skip

Returns:

the controls

Since:

1.16

initChildRendererMap

protected void initChildRendererMap()

Initialises the child control to renderer map.

Since:

1.16

getColumnLayout

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

For testing purposes.

Parameters:

numColumns - numColumns

equalWidth - equalWidth

Returns:

ColumnLayout

Since:

1.8

getSpanningLayoutData

protected java.lang.Object getSpanningLayoutData(VContainedElement child,
                                                 int spanX,
                                                 int spanY)

For testing purposes.

Parameters:

child - the element for which the spanning layout is requested

spanX - spanX

spanY - spanY

Returns:

SpanningLayoutData

Since:

1.8

getLayoutData

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

For testing purposes.

Parameters:

gridCell - gridCell

controlGridDescription - controlGridDescription

currentRowGridDescription - currentRowGridDescription

fullGridDescription - fullGridDescription

vElement - vElement

domainModel - domainModel

control - control

Returns:

LayoutData

Since:

1.8

dispose

protected void dispose()

Description copied from class: AbstractSWTRenderer

Disposes all resources used by the renderer. Don't forget to call super.dispose if overwriting this method.

Overrides:

dispose in class AbstractSWTRenderer<VCompoundControl>