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

Class AbstractControlSWTRenderer<VCONTROL extends VControl>

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>

Type Parameters:

VCONTROL - the VControl of this renderer.

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

DIControlSWTRenderer, MultiAttributeSWTRenderer, MultiReferenceSWTRenderer, SimpleControlSWTRenderer, TableControlSWTRenderer, TypedElementBoundsRenderer

public abstract class AbstractControlSWTRenderer<VCONTROL extends VControl>
extends AbstractSWTRenderer<VCONTROL>
implements RootDomainModelChangeListener

Super class for all kinds of control renderer.

Author:

Eugen Neufeld

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor	Description
AbstractControlSWTRenderer(VCONTROL vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabinding emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider)	Default constructor.
AbstractControlSWTRenderer(VCONTROL vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabinding emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider, SWTValidationHelper swtValidationHelper)	Additional constructor allowing to specify a custom SWTValidationHelper.
AbstractControlSWTRenderer(VCONTROL vElement, ViewModelContext viewContext, ReportService reportService, EMFFormsDatabinding emfFormsDatabinding, EMFFormsLabelProvider emfFormsLabelProvider, VTViewTemplateProvider vtViewTemplateProvider, SWTValidationUiService validationUiService)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected void	applyEnable()	Allows implementers to set a control to enabled.
protected void	applyReadOnly()	Marks a controls as readonly.
protected void	applyUnchangeableFeature()	This method is applied if the control's feature is configured as unchangeable.
protected boolean	canHandleControlProcessor()	Indicates if the given Control SWT renderer takes the responsibility to call a possibly existing EMFFormsControlProcessorService itself.
protected org.eclipse.swt.widgets.Control	createLabel(org.eclipse.swt.widgets.Composite parent)	Create the Control displaying the label of the current VControl.
protected org.eclipse.swt.widgets.Label	createValidationIcon(org.eclipse.swt.widgets.Composite composite)	Creates a validation icon.
protected void	defaultHandleControlProcessor(org.eclipse.swt.widgets.Control control)	Calls a possibly existing EMFFormsControlProcessorService for the given control.
protected void	defaultHandleControlProcessorForCell(org.eclipse.swt.widgets.Control control, SWTGridCell cell)	This method is called by {link render(SWTGridCell, Composite) for each control and cell if canHandleControlProcessor() returns false.
protected void	dispose()	Disposes all resources used by the renderer.
protected org.eclipse.core.databinding.DataBindingContext	getDataBindingContext()	Creates a new DataBindingContext.
protected org.eclipse.emf.edit.domain.EditingDomain	getEditingDomain(org.eclipse.emf.ecore.EObject domainModel)	Returns the EditingDomain for the provided domain model.
protected EMFFormsDatabinding	getEMFFormsDatabinding()	The EMFFormsDatabinding to use.
protected EMFFormsLabelProvider	getEMFFormsLabelProvider()	The EMFFormsLabelProvider to use.
protected int	getLabelStyleBits()
protected org.eclipse.core.databinding.observable.value.IObservableValue	getModelValue()	Returns an IObservableValue based on the control's domain model reference and domain model.
protected org.eclipse.swt.graphics.Color	getValidationBackgroundColor()	Returns the background color for the current validation result of this control's VElement.
protected org.eclipse.swt.graphics.Color	getValidationBackgroundColor(int severity)	Deprecated. use getValidationBackgroundColor() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.
protected org.eclipse.swt.graphics.Color	getValidationForegroundColor()	Returns the foreground color for the current validation result of this control's VElement.
protected org.eclipse.swt.graphics.Color	getValidationForegroundColor(int severity)	Deprecated. use getValidationForegroundColor() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.
protected org.eclipse.swt.graphics.Image	getValidationIcon()	Returns the validation icon for the current validation result of this control's VElement.
protected org.eclipse.swt.graphics.Image	getValidationIcon(int severity)	Deprecated. use getValidationIcon() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.
protected VTViewTemplateProvider	getVTViewTemplateProvider()	The VTViewTemplateProvider to use.
protected boolean	hasLeftLabelAlignment()	Whether the label for this control should be rendered on the left of the control.
protected boolean	isUnchangeableFeature()	Checks if the value referenced by the DMR can be changed or not by the user.
void	notifyChange()	Notifies this listener that the domain model of the EMFFormsViewContext has changed.
protected void	postInit()	Use this method to initialize objects which are needed during rendering.
org.eclipse.swt.widgets.Control	render(SWTGridCell cell, org.eclipse.swt.widgets.Composite parent)	Renders the passed VElement.
protected void	rootDomainModelChanged()	This method is called in notifyChange() when the root domain model of the view model context changes.

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

applyValidation, applyValidation, applyVisible, canReveal, finalizeRendering, getControls, getDefaultFontName, getGridDescription, ignoreEnableOnReadOnly, init, isRenderingFinished, preInit, renderControl, 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

AbstractControlSWTRenderer

public AbstractControlSWTRenderer(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

emfFormsDatabinding - The EMFFormsDatabinding

emfFormsLabelProvider - The EMFFormsLabelProvider

reportService - The ReportService

vtViewTemplateProvider - The VTViewTemplateProvider

Since:

1.6

AbstractControlSWTRenderer

public AbstractControlSWTRenderer(VCONTROL vElement,
                                  ViewModelContext viewContext,
                                  ReportService reportService,
                                  EMFFormsDatabinding emfFormsDatabinding,
                                  EMFFormsLabelProvider emfFormsLabelProvider,
                                  VTViewTemplateProvider vtViewTemplateProvider,
                                  SWTValidationHelper swtValidationHelper)

Additional constructor allowing to specify a custom SWTValidationHelper.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

emfFormsDatabinding - The EMFFormsDatabinding

emfFormsLabelProvider - The EMFFormsLabelProvider

reportService - The ReportService

vtViewTemplateProvider - The VTViewTemplateProvider

swtValidationHelper - The SWTValidationHelper

Since:

1.23

AbstractControlSWTRenderer

public AbstractControlSWTRenderer(VCONTROL vElement,
                                  ViewModelContext viewContext,
                                  ReportService reportService,
                                  EMFFormsDatabinding emfFormsDatabinding,
                                  EMFFormsLabelProvider emfFormsLabelProvider,
                                  VTViewTemplateProvider vtViewTemplateProvider,
                                  SWTValidationUiService validationUiService)

Default constructor.

Parameters:

vElement - the view model element to be rendered

viewContext - the view context

emfFormsDatabinding - The EMFFormsDatabinding

emfFormsLabelProvider - The EMFFormsLabelProvider

reportService - The ReportService

vtViewTemplateProvider - The VTViewTemplateProvider

validationUiService - The SWTValidationUiService

Since:

1.23

Method Detail

getEMFFormsDatabinding

protected EMFFormsDatabinding getEMFFormsDatabinding()

The EMFFormsDatabinding to use.

Returns:

The EMFFormsDatabinding

Since:

1.6

getEMFFormsLabelProvider

protected EMFFormsLabelProvider getEMFFormsLabelProvider()

The EMFFormsLabelProvider to use.

Returns:

The EMFFormsLabelProvider

Since:

1.6

getVTViewTemplateProvider

protected VTViewTemplateProvider getVTViewTemplateProvider()

The VTViewTemplateProvider to use.

Returns:

The VTViewTemplateProvider

Since:

1.6

postInit

protected void postInit()

Description copied from class: AbstractSWTRenderer

Use this method to initialize objects which are needed during rendering.

Overrides:

postInit in class AbstractSWTRenderer<VCONTROL extends VControl>

isUnchangeableFeature

protected boolean isUnchangeableFeature()

Checks if the value referenced by the DMR can be changed or not by the user.

Returns:

true if the value cannot be changed.

render

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

Description copied from class: AbstractSWTRenderer

Renders the passed VElement.

Overrides:

render in class AbstractSWTRenderer<VCONTROL extends VControl>

Parameters:

cell - the SWTGridCell 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

applyUnchangeableFeature

protected void applyUnchangeableFeature()

This method is applied if the control's feature is configured as unchangeable. The renderer is usually disabled when feature is not changeable.

Since:

1.20

canHandleControlProcessor

protected boolean canHandleControlProcessor()

Indicates if the given Control SWT renderer takes the responsibility to call a possibly existing EMFFormsControlProcessorService itself.

The default implementation returns false.

Returns:

true if the Control SWT renderer can handle the EMFFormsControlProcessorService itself, false otherwise.

Since:

1.8

defaultHandleControlProcessorForCell

protected void defaultHandleControlProcessorForCell(org.eclipse.swt.widgets.Control control,
                                                    SWTGridCell cell)

This method is called by {link render(SWTGridCell, Composite) for each control and cell if canHandleControlProcessor() returns false. The default implementation forwards to defaultHandleControlProcessor(Control) if the cell's column is 2.

Parameters:

control - The Control which is to be processed by the EMFFormsControlProcessorService.

cell - The SWTGridCell for the given control.

Since:

1.8

defaultHandleControlProcessor

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

Calls a possibly existing EMFFormsControlProcessorService for the given control.

Parameters:

control - The Control which is to be processed by the EMFFormsControlProcessorService.

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<VCONTROL extends VControl>

getValidationIcon

@Deprecated
protected final org.eclipse.swt.graphics.Image getValidationIcon(int severity)

Deprecated.

use getValidationIcon() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.

Returns the validation icon matching the given severity.

Parameters:

severity - the severity of the Diagnostic

Returns:

the icon to be displayed, or null when no icon is to be displayed

getValidationIcon

protected final org.eclipse.swt.graphics.Image getValidationIcon()

Returns the validation icon for the current validation result of this control's VElement.

Returns:

the icon to be displayed, or null when no icon is to be displayed

Since:

1.23

getValidationBackgroundColor

@Deprecated
protected final org.eclipse.swt.graphics.Color getValidationBackgroundColor(int severity)

Deprecated.

use getValidationBackgroundColor() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.

Returns the background color for a control with the given validation severity.

Parameters:

severity - severity the severity of the Diagnostic

Returns:

the color to be used as a background color

getValidationBackgroundColor

protected final org.eclipse.swt.graphics.Color getValidationBackgroundColor()

Returns the background color for the current validation result of this control's VElement.

Returns:

the color to be used as a background color

Since:

1.23

getValidationForegroundColor

@Deprecated
protected final org.eclipse.swt.graphics.Color getValidationForegroundColor(int severity)

Deprecated.

use getValidationForegroundColor() for default behavior or use the SWTValidationUiService if you need to get the color for a specific diagnostic.

Returns the foreground color for a control with the given validation severity.

Parameters:

severity - severity the severity of the Diagnostic

Returns:

the color to be used as a foreground color

Since:

1.10

getValidationForegroundColor

protected final org.eclipse.swt.graphics.Color getValidationForegroundColor()

Returns the foreground color for the current validation result of this control's VElement.

Returns:

the color to be used as a foreground color

Since:

1.23

getDataBindingContext

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

Creates a new DataBindingContext.

Returns:

a new DataBindingContext each time this method is called

getModelValue

protected final org.eclipse.core.databinding.observable.value.IObservableValue getModelValue()
                                                                                      throws DatabindingFailedException

Returns an IObservableValue based on the control's domain model reference and domain model.

Returns:

the IObservableValue

Throws:

DatabindingFailedException - if the databinding of the domain model object fails.

Since:

1.6

getEditingDomain

protected final org.eclipse.emf.edit.domain.EditingDomain getEditingDomain(org.eclipse.emf.ecore.EObject domainModel)

Returns the EditingDomain for the provided domain model.

Parameters:

domainModel - The provided domain model

Returns:

The EditingDomain of this domain model

Since:

1.6

createLabel

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

Create the Control displaying the label of the current VControl.

Parameters:

parent - the Composite to render onto

Returns:

the created Control or null

getLabelStyleBits

protected int getLabelStyleBits()

Returns:

the style bits for the control's label

Since:

1.16

hasLeftLabelAlignment

protected boolean hasLeftLabelAlignment()

Whether the label for this control should be rendered on the left of the control. This is the case if the VControl.getLabelAlignment() is set to LabelAlignment.LEFT or LabelAlignment.DEFAULT.

Returns:

true if label should be on the left, false otherwise

Since:

1.7

createValidationIcon

protected org.eclipse.swt.widgets.Label createValidationIcon(org.eclipse.swt.widgets.Composite composite)

Creates a validation icon.

Parameters:

composite - the Composite to create onto

Returns:

the created Label

applyEnable

protected void applyEnable()

Allows implementers to set a control to enabled.

Overrides:

applyEnable in class AbstractSWTRenderer<VCONTROL extends VControl>

Since:

1.6

See Also:

AbstractSWTRenderer.applyEnable()

notifyChange

public void notifyChange()

Notifies this listener that the domain model of the EMFFormsViewContext has changed.

Specified by:

notifyChange in interface RootDomainModelChangeListener

Since:

1.9

See Also:

RootDomainModelChangeListener.notifyChange()

rootDomainModelChanged

protected void rootDomainModelChanged()
                               throws DatabindingFailedException

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

Throws:

DatabindingFailedException - If the databinding failed

Since:

1.9

applyReadOnly

protected void applyReadOnly()

Marks a controls as readonly.

Overrides:

applyReadOnly in class AbstractSWTRenderer<VCONTROL extends VControl>

See Also:

AbstractSWTRenderer.applyReadOnly()