org.eclipse.emf.ecp.view.internal.core.swt.renderer

Class EnumComboViewerSWTRenderer

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

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

org.eclipse.emf.ecp.view.internal.core.swt.renderer.EnumComboViewerSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

EnumLiteralFilteredComboViewerSWTRenderer

public class EnumComboViewerSWTRenderer
extends SimpleControlJFaceViewerSWTRenderer

Renderer for Enums.

Author:

Eugen Neufeld

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.core.databinding.Binding[]	createBindings(org.eclipse.jface.viewers.Viewer viewer) Create the Bindings for this controls.
protected org.eclipse.jface.viewers.ComboViewer	createComboViewer(org.eclipse.swt.widgets.Composite parent, org.eclipse.emf.ecore.EEnum eEnum) Create a new ComboViewer instance.
protected org.eclipse.jface.viewers.Viewer	createJFaceViewer(org.eclipse.swt.widgets.Composite parent) Creates the Viewer.
protected void	dispose() Disposes all resources used by the renderer.
protected org.eclipse.core.databinding.observable.value.IObservableValue<Collection<?>>	getAvailableChoicesValue() Obtains the combo viewer input as an observable value.
List<org.eclipse.emf.ecore.EEnumLiteral>	getELiterals(org.eclipse.emf.ecore.EEnum eEnum) Returns the list of literals of the enum.
protected EMFFormsEditSupport	getEMFFormsEditSupport() Return the EMFFormsEditSupport.
protected String	getUnsetText() Provide the unset text to show on the label when value is unset.
protected void	rootDomainModelChanged() This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.

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

createControl

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

applyReadOnly, applyValidation, createControlCell, createDefaultUnsettableStyleProperty, createLabelCell, createValidationCell, getGridDescription, getLabelWidth, getUnsettableStyleProperty, isUnsettable, renderControl, setControlEnabled, setControlIdData, setValidationColor, setValidationForegroundColor

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, getValidationForegroundColor, 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

EnumComboViewerSWTRenderer

@Inject
public EnumComboViewerSWTRenderer(VControl vElement,
                                          ViewModelContext viewContext,
                                          ReportService reportService,
                                          EMFFormsDatabinding emfFormsDatabinding,
                                          EMFFormsLabelProvider emfFormsLabelProvider,
                                          VTViewTemplateProvider vtViewTemplateProvider,
                                          EMFFormsEditSupport emfFormsEditSupport)

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

emfFormsEditSupport - The EMFFormsEditSupport

Method Detail

createBindings

protected org.eclipse.core.databinding.Binding[] createBindings(org.eclipse.jface.viewers.Viewer viewer)
                                                         throws DatabindingFailedException

Description copied from class: SimpleControlJFaceViewerSWTRenderer

Create the Bindings for this controls.

Specified by:

createBindings in class SimpleControlJFaceViewerSWTRenderer

Parameters:

viewer - the Viewer to create the binding for

Returns:

all the bindings created by this renderer

Throws:

DatabindingFailedException - if the creation of the bindings failed

createComboViewer

protected org.eclipse.jface.viewers.ComboViewer createComboViewer(org.eclipse.swt.widgets.Composite parent,
                                                                  org.eclipse.emf.ecore.EEnum eEnum)

Create a new ComboViewer instance. Overwrite this method in case you need a custom CCombo instance.

Parameters:

parent - the parent container

eEnum - the enum being rendered

Returns:

a ComboViewer

createJFaceViewer

protected org.eclipse.jface.viewers.Viewer createJFaceViewer(org.eclipse.swt.widgets.Composite parent)
                                                      throws DatabindingFailedException

Description copied from class: SimpleControlJFaceViewerSWTRenderer

Creates the Viewer.

Specified by:

createJFaceViewer in class SimpleControlJFaceViewerSWTRenderer

Parameters:

parent - the Composite to use as a parent

Returns:

the created Viewer

Throws:

DatabindingFailedException - if the databinding fails

getELiterals

public List<org.eclipse.emf.ecore.EEnumLiteral> getELiterals(org.eclipse.emf.ecore.EEnum eEnum)

Returns the list of literals of the enum.

Parameters:

eEnum - the enum to get the literals for

Returns:

a list of literals

getAvailableChoicesValue

protected org.eclipse.core.databinding.observable.value.IObservableValue<Collection<?>> getAvailableChoicesValue()
                                                                                                          throws DatabindingFailedException

Obtains the combo viewer input as an observable value. This is an observable value, not an observable collection, because

• it is not to be treated as a mutable collection, and
• it is used as a viewer input, which is an opaque object

Returns:

the available-choices value

Throws:

DatabindingFailedException - on failure to get the model value

rootDomainModelChanged

protected void rootDomainModelChanged()
                               throws DatabindingFailedException

Description copied from class: SimpleControlJFaceViewerSWTRenderer

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

Overrides:

rootDomainModelChanged in class SimpleControlJFaceViewerSWTRenderer

Throws:

DatabindingFailedException - If the databinding failed

See Also:

AbstractControlSWTRenderer.rootDomainModelChanged()

dispose

protected void dispose()

Description copied from class: SimpleControlSWTRenderer

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

Overrides:

dispose in class SimpleControlSWTRenderer

See Also:

AbstractSWTRenderer.dispose()

getUnsetText

protected String getUnsetText()

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

Specified by:

getUnsetText in class SimpleControlSWTRenderer

Returns:

the text to show on the unset label

See Also:

SimpleControlSWTRenderer.getUnsetText()

getEMFFormsEditSupport

protected EMFFormsEditSupport getEMFFormsEditSupport()

Return the EMFFormsEditSupport.

Returns:

the EMFFormsEditSupport