org.eclipse.emf.ecp.view.internal.control.multireference

Class MultiReferenceSWTRenderer

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.internal.control.multireference.MultiReferenceSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

LinkOnlyMultiReferenceRenderer

public class MultiReferenceSWTRenderer
extends AbstractControlSWTRenderer<VControl>

Renderer for MultiReferenceControl.

Author:

Eugen Neufeld

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	applyValidation() Allows implementers to display the validation state of the control.
protected org.eclipse.swt.widgets.Button	createAddExistingButton(org.eclipse.swt.widgets.Composite parent, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Creates a button that enables the addition of existing references to the given EStructuralFeature.
protected org.eclipse.swt.widgets.Button	createAddNewButton(org.eclipse.swt.widgets.Composite parent, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Creates a button that enables the addition of newly created references to the given EStructuralFeature.
protected void	createButtonComposite(org.eclipse.swt.widgets.Composite parent) Adds a composite with the buttons 'AddExisting', 'AddNew' and 'Delete' to the given Composite if necessary.
protected org.eclipse.swt.widgets.Composite	createControlComposite(org.eclipse.swt.widgets.Composite composite) Creates the composite which will be the parent for the table.
protected org.eclipse.swt.widgets.Button	createDeleteButton(org.eclipse.swt.widgets.Composite parent, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Creates a button that enables the removal of existing references from the given EStructuralFeature.
protected org.eclipse.swt.widgets.Control	createErrorLabel(org.eclipse.swt.widgets.Composite parent, Exception ex) Creates an error label for the given Exception.
protected void	createTitleComposite(org.eclipse.swt.widgets.Composite parent) Creates a composite with a label, a validation icon and a button composite.
protected void	dispose() Disposes all resources used by the renderer.
SWTGridDescription	getGridDescription(SWTGridDescription gridDescription) Returns the GridDescription for this Renderer.
protected org.eclipse.swt.graphics.Image	getImage(String path) Returns an Image from the image registry.
protected int	getTableHeightHint() Returns the height for the table that will be created.
protected org.eclipse.jface.viewers.TableViewer	getTableViewer() Gives access to the tableViewer used to display the attributes.
protected void	handleAddExisting(org.eclipse.jface.viewers.TableViewer tableViewer, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Method for adding an existing element.
protected void	handleAddNew(org.eclipse.jface.viewers.TableViewer tableViewer, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Method for adding a new element.
protected void	handleDelete(org.eclipse.jface.viewers.TableViewer tableViewer, org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature structuralFeature) Method for deleting elements.
protected void	handleDoubleClick(org.eclipse.emf.ecore.EObject selectedObject) Method for handling a double click.
protected org.eclipse.swt.widgets.Control	renderControl(SWTGridCell cell, 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 boolean	showAddExistingButton() Returns true if the 'AddExisting' button is shown, false otherwise.
protected boolean	showAddNewButton() Returns true if the 'AddNew' button is shown, false otherwise.
protected boolean	showDeleteButton() Returns true if the 'Delete' button is shown, false otherwise.

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

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

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

applyReadOnly, applyVisible, finalizeRendering, getControls, getDefaultFontName, init, preInit, setControlEnabled

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

checkRenderer, getReportService, getVElement, getViewModelContext

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiReferenceSWTRenderer

@Inject
public MultiReferenceSWTRenderer(VControl vElement,
                                         ViewModelContext viewContext,
                                         ReportService reportService,
                                         EMFFormsDatabinding emfFormsDatabinding,
                                         EMFFormsLabelProvider emfFormsLabelProvider,
                                         VTViewTemplateProvider vtViewTemplateProvider,
                                         ImageRegistryService imageRegistryService)

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

imageRegistryService - The ImageRegistryService

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(org.eclipse.emfforms.spi.swt.core.layout.SWTGridDescription)

showAddExistingButton

protected boolean showAddExistingButton()

Returns true if the 'AddExisting' button is shown, false otherwise.

Returns:

true if the 'AddExisting' button is shown, false otherwise

showAddNewButton

protected boolean showAddNewButton()

Returns true if the 'AddNew' button is shown, false otherwise.

Returns:

true if the 'AddNew' button is shown, false otherwise

showDeleteButton

protected boolean showDeleteButton()

Returns true if the 'Delete' button is shown, false otherwise.

Returns:

true if the 'Delete' button is shown, false otherwise

renderControl

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

Renders the passed VElement.

Specified by:

renderControl in class AbstractSWTRenderer<VControl>

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

See Also:

org.eclipse.emfforms.spi.swt.core.AbstractSWTRenderer#renderControl(org.eclipse.emfforms.spi.swt.core.layout.SWTGridCell, org.eclipse.emf.ecp.view.spi.swt.Composite)

createControlComposite

protected org.eclipse.swt.widgets.Composite createControlComposite(org.eclipse.swt.widgets.Composite composite)

Creates the composite which will be the parent for the table.

Parameters:

composite - the parent composite

Returns:

the table composite

getTableHeightHint

protected int getTableHeightHint()

Returns the height for the table that will be created.

Returns:

the height hint

getTableViewer

protected org.eclipse.jface.viewers.TableViewer getTableViewer()

Gives access to the tableViewer used to display the attributes.

Returns:

the viewer

createErrorLabel

protected org.eclipse.swt.widgets.Control createErrorLabel(org.eclipse.swt.widgets.Composite parent,
                                                           Exception ex)

Creates an error label for the given Exception.

Parameters:

parent - The parent of the Label

ex - The Exception causing the error

Returns:

The error Label

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:

AbstractControlSWTRenderer.dispose()

createAddExistingButton

protected org.eclipse.swt.widgets.Button createAddExistingButton(org.eclipse.swt.widgets.Composite parent,
                                                                 org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Creates a button that enables the addition of existing references to the given EStructuralFeature.

Parameters:

parent - The parent of the created Button

structuralFeature - The EStructuralFeature to which references are added

Returns:

The newly created Button

createAddNewButton

protected org.eclipse.swt.widgets.Button createAddNewButton(org.eclipse.swt.widgets.Composite parent,
                                                            org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Creates a button that enables the addition of newly created references to the given EStructuralFeature.

Parameters:

parent - The parent of the created Button

structuralFeature - The EStructuralFeature to which references are added

Returns:

The newly created Button

createDeleteButton

protected org.eclipse.swt.widgets.Button createDeleteButton(org.eclipse.swt.widgets.Composite parent,
                                                            org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Creates a button that enables the removal of existing references from the given EStructuralFeature.

Parameters:

parent - The parent of the newly created Button

structuralFeature - The EStructuralFeature from which references are removed

Returns:

The newly created Button

createButtonComposite

protected void createButtonComposite(org.eclipse.swt.widgets.Composite parent)
                              throws DatabindingFailedException

Adds a composite with the buttons 'AddExisting', 'AddNew' and 'Delete' to the given Composite if necessary.

Parameters:

parent - The parent of the created Composite

Throws:

DatabindingFailedException - thrown if the databinding could not be executed successfully

createTitleComposite

protected void createTitleComposite(org.eclipse.swt.widgets.Composite parent)
                             throws DatabindingFailedException

Creates a composite with a label, a validation icon and a button composite.

Parameters:

parent - The parent of the created Composite

Throws:

DatabindingFailedException - thrown if the databinding could not be executed successfully

getImage

protected org.eclipse.swt.graphics.Image getImage(String path)

Returns an Image from the image registry.

Parameters:

path - the path to the image

Returns:

the image

handleDoubleClick

protected void handleDoubleClick(org.eclipse.emf.ecore.EObject selectedObject)

Method for handling a double click.

Parameters:

selectedObject - the selected EObject

handleAddExisting

protected void handleAddExisting(org.eclipse.jface.viewers.TableViewer tableViewer,
                                 org.eclipse.emf.ecore.EObject eObject,
                                 org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Method for adding an existing element.

Parameters:

tableViewer - the TableViewer

eObject - The EObject to add to

structuralFeature - The corresponding EStructuralFeature

handleAddNew

protected void handleAddNew(org.eclipse.jface.viewers.TableViewer tableViewer,
                            org.eclipse.emf.ecore.EObject eObject,
                            org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Method for adding a new element.

Parameters:

tableViewer - the TableViewer

eObject - The EObject to add to

structuralFeature - The corresponding EStructuralFeature

handleDelete

protected void handleDelete(org.eclipse.jface.viewers.TableViewer tableViewer,
                            org.eclipse.emf.ecore.EObject eObject,
                            org.eclipse.emf.ecore.EStructuralFeature structuralFeature)

Method for deleting elements.

Parameters:

tableViewer - the TableViewer

eObject - The EObject to delete from

structuralFeature - The corresponding EStructuralFeature

rootDomainModelChanged

protected void rootDomainModelChanged()
                               throws DatabindingFailedException

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

See Also:

AbstractControlSWTRenderer.rootDomainModelChanged()

applyValidation

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