org.eclipse.emfforms.spi.view.control.multiattribute

Class MultiAttributeSWTRenderer

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.emfforms.spi.view.control.multiattribute.MultiAttributeSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

EcorePathsRenderer

public class MultiAttributeSWTRenderer
extends AbstractControlSWTRenderer<VControl>

Renderer for MultiReferenceControl.

Author:

David Soto Setzke, Johannes Faltermeier

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor and Description
MultiAttributeSWTRenderer(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	applyEnable() Allows implementers to set a control to enabled.
protected void	applyReadOnly() Marks a controls as readonly.
protected void	applyValidation() Allows implementers to display the validation state of the control.
protected org.eclipse.swt.widgets.Composite	createButtonComposite(org.eclipse.swt.widgets.Composite parent, org.eclipse.core.databinding.observable.list.IObservableList list) Create the button composite.
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 VTTableStyleProperty	createDefaultTableStyleProperty() Creates the default VTTableStyleProperty.
protected org.eclipse.swt.widgets.Control	createErrorLabel(org.eclipse.swt.widgets.Composite parent, Exception ex) Creates an error label for the given Exception.
protected org.eclipse.swt.widgets.Composite	createTitleComposite(org.eclipse.swt.widgets.Composite parent) Creates the Title Composite containing validation and buttons.
protected void	createUpDownButtons(org.eclipse.swt.widgets.Composite composite, org.eclipse.core.databinding.observable.list.IObservableList list) Create the up and down buttons.
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 VTTableStyleProperty	getTableStyleProperty() Returns the VTTableStyleProperty.
protected org.eclipse.jface.viewers.TableViewer	getTableViewer() Gives access to the tableViewer used to display the attributes.
protected Object	getValueForNewRow(org.eclipse.emf.ecore.EAttribute attribute) Returns the attribute value which should be added as a new element.
protected boolean	ignoreEnableOnReadOnly() Returns true when read only will always force control to be disabled.
protected void	initButtons(org.eclipse.core.databinding.observable.list.IObservableList list) Initializes the buttons.
protected void	postRemove(org.eclipse.jface.viewers.IStructuredSelection selection) This is called after the selected elements were deleted so that the user can handle this removal.
protected org.eclipse.swt.widgets.Control	renderControl(SWTGridCell cell, org.eclipse.swt.widgets.Composite parent) Renders the passed VElement.
protected org.eclipse.swt.widgets.Control	renderMultiAttributeControl(SWTGridCell cell, org.eclipse.swt.widgets.Composite parent) Renders the MultiAttribute Control.
protected void	rootDomainModelChanged() This method is called in AbstractControlSWTRenderer.notifyChange() when the root domain model of the view model context changes.
protected void	updateButtonEnabling() Updates the enablement of 'addExisting', 'addNew', 'delete', 'moveUp' and 'moveDown' buttons according to the bound input.
protected void	updateButtons() Updates button visibility and enablement.
protected void	updateButtonVisibility() Updates the visibility of 'Add', 'Remove', 'Up', 'Down' buttons according to the bound input.

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

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, init, isRenderingFinished, preInit, 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

MultiAttributeSWTRenderer

@Inject
public MultiAttributeSWTRenderer(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

createDefaultTableStyleProperty

protected VTTableStyleProperty createDefaultTableStyleProperty()

Creates the default VTTableStyleProperty.

Returns:

the default VTTableStyleProperty

Since:

1.14

getTableStyleProperty

protected VTTableStyleProperty getTableStyleProperty()

Returns the VTTableStyleProperty.

Returns:

the VTTableStyleProperty

Since:

1.14

getGridDescription

public SWTGridDescription getGridDescription(SWTGridDescription gridDescription)

Description copied from class: AbstractSWTRenderer

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

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

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

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

applyReadOnly

protected void applyReadOnly()

Description copied from class: AbstractControlSWTRenderer

Marks a controls as readonly.

Overrides:

applyReadOnly in class AbstractControlSWTRenderer<VControl>

See Also:

AbstractSWTRenderer.applyReadOnly()

ignoreEnableOnReadOnly

protected boolean ignoreEnableOnReadOnly()

Description copied from class: AbstractSWTRenderer

Returns true when read only will always force control to be disabled.

Overrides:

ignoreEnableOnReadOnly in class AbstractSWTRenderer<VControl>

Returns:

true when read only will always force control to be disabled.

updateButtons

protected void updateButtons()

Updates button visibility and enablement.

updateButtonVisibility

protected void updateButtonVisibility()

Updates the visibility of 'Add', 'Remove', 'Up', 'Down' buttons according to the bound input.

updateButtonEnabling

protected void updateButtonEnabling()

Updates the enablement of 'addExisting', 'addNew', 'delete', 'moveUp' and 'moveDown' buttons according to the bound input.

renderControl

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

Description copied from class: AbstractSWTRenderer

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:

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

NoRendererFoundException - this is thrown when a renderer cannot be found

renderMultiAttributeControl

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

Renders the MultiAttribute Control. Renders the MultiReference control including validation and buttons when RenderMode is set to RenderMode.DEFAULT. Only renders the MultiReferfence control without validation and buttons when renderMode is set to RenderMode.COMPACT_VERTICALLY.

Parameters:

cell - the SWTGridCell.

parent - the Composite.

Returns:

the rendered Control

Throws:

NoRendererFoundException - the NoRendererFoundException.

NoPropertyDescriptorFoundExeption - the NoPropertyDescriptorFoundExeption.

Since:

1.14

createTitleComposite

protected org.eclipse.swt.widgets.Composite createTitleComposite(org.eclipse.swt.widgets.Composite parent)

Creates the Title Composite containing validation and buttons. Buttons have to be initialized afterwards.

Parameters:

parent - the parent Composite.

Returns:

the created Composite.

Since:

1.14

createButtonComposite

protected org.eclipse.swt.widgets.Composite createButtonComposite(org.eclipse.swt.widgets.Composite parent,
                                                                  org.eclipse.core.databinding.observable.list.IObservableList list)

Create the button composite. Buttons have to be initialized after the table is created.

Parameters:

parent - the Composite parent.

list - the IObservableList.

Returns:

the created Composite.

Since:

1.14

initButtons

protected void initButtons(org.eclipse.core.databinding.observable.list.IObservableList list)

Initializes the buttons. Call this after table is created.

Parameters:

list - the IObservableList.

Since:

1.14

createUpDownButtons

protected void createUpDownButtons(org.eclipse.swt.widgets.Composite composite,
                                   org.eclipse.core.databinding.observable.list.IObservableList list)

Create the up and down buttons.

Parameters:

composite - The Composite to create the buttons on

list - The IObservableList of the current MultiAttributeSWTRenderer

Since:

1.17

getValueForNewRow

protected Object getValueForNewRow(org.eclipse.emf.ecore.EAttribute attribute)

Returns the attribute value which should be added as a new element.

Parameters:

attribute - the EAttribute with the data type

Returns:

the new value

Since:

1.13

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>

applyEnable

protected void applyEnable()

Allows implementers to set a control to enabled.

Overrides:

applyEnable in class AbstractControlSWTRenderer<VControl>

See Also:

AbstractControlSWTRenderer.applyEnable()

dispose

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

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()

postRemove

protected void postRemove(org.eclipse.jface.viewers.IStructuredSelection selection)

This is called after the selected elements were deleted so that the user can handle this removal.

Parameters:

selection - The IStructuredSelection of the TableViewer before deletion.

Since:

1.17

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

Since:

1.14