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

Class SimpleControlSWTRenderer

java.lang.Object

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

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

org.eclipse.emf.ecp.view.spi.core.swt.AbstractControlSWTRenderer<VControl>

org.eclipse.emf.ecp.view.spi.core.swt.SimpleControlSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

SimpleControlJFaceViewerSWTRenderer, SimpleControlSWTControlSWTRenderer, TableColumnsDMRTableControl

public abstract class SimpleControlSWTRenderer
extends AbstractControlSWTRenderer<VControl>

Author:

Eugen

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor	Description
SimpleControlSWTRenderer(VControl vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabinding emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	applyReadOnly()	Marks a controls as readonly.
protected void	applyValidation()	Allows implementers to display the validation state of the control.
protected abstract org.eclipse.swt.widgets.Control	createControl(org.eclipse.swt.widgets.Composite parent)	Creates the control itself.
protected SWTGridCell	createControlCell(int column)	Creates the control cell.
protected VTUnsettableStyleProperty	createDefaultUnsettableStyleProperty()	Creates the default VTUnsettableStyleProperty.
protected SWTGridCell	createLabelCell(int column)	Creates the label cell if necessary.
protected SWTGridCell	createValidationCell(int column)	Creates the validation cell.
protected void	dispose()	Disposes all resources used by the renderer.
SWTGridDescription	getGridDescription(SWTGridDescription gridDescription)	Returns the GridDescription for this Renderer.
protected Optional<java.lang.Integer>	getLabelWidth()
protected VTUnsettableStyleProperty	getUnsettableStyleProperty()	Returns the VTUnsettableStyleProperty.
protected abstract java.lang.String	getUnsetText()	Provide the unset text to show on the label when value is unset.
protected boolean	isUnsettable()	Returns true if the control is unsettable.
protected org.eclipse.swt.widgets.Control	renderControl(SWTGridCell gridCell, org.eclipse.swt.widgets.Composite parent)	Renders the passed VElement.
protected void	rootDomainModelChanged()	This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.
protected void	setControlEnabled(SWTGridCell gridCell, org.eclipse.swt.widgets.Control control, boolean enabled)	Wraps the call to enable/disable a control.
protected void	setControlIdData(org.eclipse.swt.widgets.Control control)	This method will set the element id data on the control created by createControl(Composite).
protected void	setValidationColor(org.eclipse.swt.widgets.Control control, org.eclipse.swt.graphics.Color validationColor)	Set the provided validation color as the background for the provided control.
protected void	setValidationForegroundColor(org.eclipse.swt.widgets.Control control, org.eclipse.swt.graphics.Color validationColor)	Set the provided validation color as the foreground for the provided control.

Methods inherited from class org.eclipse.emf.ecp.view.spi.core.swt.AbstractControlSWTRenderer

applyEnable, applyUnchangeableFeature, canHandleControlProcessor, createLabel, createValidationIcon, defaultHandleControlProcessor, defaultHandleControlProcessorForCell, getDataBindingContext, getEditingDomain, getEMFFormsDatabinding, getEMFFormsLabelProvider, getLabelStyleBits, getModelValue, getValidationBackgroundColor, getValidationBackgroundColor, getValidationForegroundColor, getValidationForegroundColor, getValidationIcon, getValidationIcon, getVTViewTemplateProvider, hasLeftLabelAlignment, isUnchangeableFeature, notifyChange, postInit, render

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

applyValidation, applyVisible, canReveal, finalizeRendering, getControls, getDefaultFontName, ignoreEnableOnReadOnly, init, isRenderingFinished, preInit, scrollToReveal, scrollToReveal

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

SimpleControlSWTRenderer

public SimpleControlSWTRenderer(VControl vElement,
                                ViewModelContext viewContext,
                                ReportService reportService,
                                EMFFormsDatabinding emfFormsDatabinding,
                                EMFFormsLabelProvider emfFormsLabelProvider,
                                VTViewTemplateProvider vtViewTemplateProvider)

Default constructor.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

reportService - The ReportService

emfFormsDatabinding - The EMFFormsDatabinding

emfFormsLabelProvider - The EMFFormsLabelProvider

vtViewTemplateProvider - The VTViewTemplateProvider

Since:

1.6

Method Detail

getGridDescription

public SWTGridDescription getGridDescription(SWTGridDescription gridDescription)

Returns the GridDescription for this Renderer.

Specified by:

getGridDescription in class AbstractSWTRenderer<VControl>

Parameters:

gridDescription - the current SWTGridDescription

Returns:

the number of controls per row

See Also:

AbstractSWTRenderer.getGridDescription(SWTGridDescription)

createLabelCell

protected SWTGridCell createLabelCell(int column)

Creates the label cell if necessary.

Parameters:

column - column number within the grid row

Returns:

created and configured label cell

Since:

1.9

getLabelWidth

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

Returns:

an optional width for the control's label

Since:

1.16

createValidationCell

protected SWTGridCell createValidationCell(int column)

Creates the validation cell.

Parameters:

column - column number within the grid row

Returns:

created and configured label cell

Since:

1.9

createControlCell

protected SWTGridCell createControlCell(int column)

Creates the control cell.

Parameters:

column - column number within the grid row

Returns:

created and configured label cell

Since:

1.9

renderControl

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

Renders the passed VElement.

Specified by:

renderControl in class AbstractSWTRenderer<VControl>

Parameters:

gridCell - 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

See Also:

org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer#renderControl(int, org.eclipse.swt.widgets.Composite, org.eclipse.emf.ecp.view.spi.model.VElement, org.eclipse.emf.ecp.view.spi.context.ViewModelContext)

isUnsettable

protected boolean isUnsettable()
                        throws DatabindingFailedException

Returns true if the control is unsettable.

Returns:

true if unsettable, false otherwise

Throws:

DatabindingFailedException - if the databinding fails

getUnsetText

protected abstract java.lang.String getUnsetText()

Provide the unset text to show on the label when value is unset.

Returns:

the text to show on the unset label

setValidationColor

protected void setValidationColor(org.eclipse.swt.widgets.Control control,
                                  org.eclipse.swt.graphics.Color validationColor)

Set the provided validation color as the background for the provided control.

Parameters:

control - the control to set the color on

validationColor - the validation color to set

setValidationForegroundColor

protected void setValidationForegroundColor(org.eclipse.swt.widgets.Control control,
                                            org.eclipse.swt.graphics.Color validationColor)

Set the provided validation color as the foreground for the provided control.

Parameters:

control - the control to set the color on

validationColor - the validation color to set

Since:

1.10

setControlEnabled

protected void setControlEnabled(SWTGridCell gridCell,
                                 org.eclipse.swt.widgets.Control control,
                                 boolean enabled)

Description copied from class: AbstractSWTRenderer

Wraps the call to enable/disable a control.

Overrides:

setControlEnabled in class AbstractSWTRenderer<VControl>

Parameters:

gridCell - the SWTGridCell to enable/disable

control - the Control to enable/disable

enabled - true if control should be enabled, false otherwise

applyValidation

protected final void applyValidation()

Description copied from class: AbstractSWTRenderer

Allows implementers to display the validation state of the control. The default implementation does nothing.

Overrides:

applyValidation in class AbstractSWTRenderer<VControl>

createControl

protected abstract org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent)
                                                          throws DatabindingFailedException

Creates the control itself.

Parameters:

parent - the Composite to render onto

Returns:

the rendered control

Throws:

DatabindingFailedException - if the databinding of the control fails

setControlIdData

protected void setControlIdData(org.eclipse.swt.widgets.Control control)

This method will set the element id data on the control created by createControl(Composite).

Parameters:

control - the control created by createControl(Composite)

Since:

1.9

dispose

protected void dispose()

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

Overrides:

dispose in class AbstractControlSWTRenderer<VControl>

See Also:

AbstractSWTRenderer.dispose()

rootDomainModelChanged

protected void rootDomainModelChanged()
                               throws DatabindingFailedException

Description copied from class: AbstractControlSWTRenderer

This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.

Overrides:

rootDomainModelChanged in class AbstractControlSWTRenderer<VControl>

Throws:

DatabindingFailedException - If the databinding failed

createDefaultUnsettableStyleProperty

protected VTUnsettableStyleProperty createDefaultUnsettableStyleProperty()

Creates the default VTUnsettableStyleProperty.

Returns:

the default VTUnsettableStyleProperty

Since:

1.14

getUnsettableStyleProperty

protected VTUnsettableStyleProperty getUnsettableStyleProperty()

Returns the VTUnsettableStyleProperty.

Returns:

the VTUnsettableStyleProperty

Since:

1.14

applyReadOnly

protected void applyReadOnly()

Description copied from class: AbstractControlSWTRenderer

Marks a controls as readonly.

Overrides:

applyReadOnly in class AbstractControlSWTRenderer<VControl>

See Also:

AbstractSWTRenderer.applyReadOnly()