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

Class TextControlSWTRenderer

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.SimpleControlSWTControlSWTRenderer

org.eclipse.emf.ecp.view.spi.core.swt.renderer.TextControlSWTRenderer

All Implemented Interfaces:

RootDomainModelChangeListener

Direct Known Subclasses:

InstanceTypeNameSWTRenderer, NumberControlSWTRenderer, RichTextControlSWTRenderer, XMLDateControlSWTRenderer

public class TextControlSWTRenderer
extends SimpleControlSWTControlSWTRenderer

Renders texts.

Since:

1.5

Author:

Eugen Neufeld

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TextControlSWTRenderer.ModelToTargetUpdateStrategy The strategy to convert from model to target.
protected class	TextControlSWTRenderer.TargetToModelUpdateStrategy The strategy to convert from target to model.

Field Summary

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

CUSTOM_VARIANT

Constructor Summary

Constructors

Constructor and Description
TextControlSWTRenderer(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	bindValue(org.eclipse.swt.widgets.Control text, org.eclipse.core.databinding.observable.value.IObservableValue modelValue, org.eclipse.core.databinding.DataBindingContext dataBindingContext, org.eclipse.core.databinding.UpdateValueStrategy targetToModel, org.eclipse.core.databinding.UpdateValueStrategy modelToTarget) Creates a focus out binding for this control.
protected Object	convert(org.eclipse.swt.widgets.Text text, org.eclipse.emf.ecore.EDataType attributeType, String value) Convert the given value from target to model.
protected org.eclipse.core.databinding.Binding[]	createBindings(org.eclipse.swt.widgets.Control control) Create the Bindings for this controls.
protected org.eclipse.swt.widgets.Control	createSWTControl(org.eclipse.swt.widgets.Composite parent) Creates the Control.
protected org.eclipse.core.databinding.Binding	createTooltipBinding(org.eclipse.swt.widgets.Control text, org.eclipse.core.databinding.observable.value.IObservableValue modelValue, org.eclipse.core.databinding.DataBindingContext dataBindingContext, org.eclipse.core.databinding.UpdateValueStrategy targetToModel, org.eclipse.core.databinding.UpdateValueStrategy modelToTarget) Creates a tooltip binding for this control.
protected org.eclipse.swt.widgets.Control	getControlCompositeFromControl(org.eclipse.swt.widgets.Control control) Returns the control composite that contains the text field from the parent composite created by the SimpleControlSWTRenderer.
protected int	getDefaultAlignment() Return the default alignment value for this renderer.
protected EMFFormsEditSupport	getEMFFormsEditSupport()
protected String	getTextFromTextField(org.eclipse.swt.widgets.Text text, org.eclipse.emf.ecore.EDataType attributeType) Gets the text displayed in the textfield.
protected String	getTextMessage() Returns the text which should be set as the message text on the Text field.
protected String	getTextVariantID() The VariantId to use e.g.
protected int	getTextWidgetStyle() The style to apply to the text widget.
protected String	getUnsetText() Provide the unset text to show on the label when value is unset.
protected boolean	isUnsetButtonLeftOfControlComposite() Returns whether the unset button is placed left of the control composite containing the text field.
protected void	setControlEnabled(SWTGridCell gridCell, org.eclipse.swt.widgets.Control control, boolean enabled) Wraps the call to enable/disable a control.
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.
protected boolean	useOnModifyDatabinding() Whether SWT.Modify or SWT.FocusOut shall be used as the target databinding trigger.

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

createControl, getFeature, rootDomainModelChanged, withPreSetValidation

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

applyReadOnly, applyValidation, createControlCell, createDefaultUnsettableStyleProperty, createLabelCell, createValidationCell, dispose, getGridDescription, getLabelWidth, getUnsettableStyleProperty, isUnsettable, renderControl, setControlIdData

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

TextControlSWTRenderer

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

Since:

1.6

Method Detail

createBindings

protected org.eclipse.core.databinding.Binding[] createBindings(org.eclipse.swt.widgets.Control control)
                                                         throws DatabindingFailedException

Description copied from class: SimpleControlSWTControlSWTRenderer

Create the Bindings for this controls.

Specified by:

createBindings in class SimpleControlSWTControlSWTRenderer

Parameters:

control - the Control to create the binding for

Returns:

all the bindings created by this renderer

Throws:

DatabindingFailedException - if the creation of the bindings fails.

createSWTControl

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

Description copied from class: SimpleControlSWTControlSWTRenderer

Creates the Control.

Specified by:

createSWTControl in class SimpleControlSWTControlSWTRenderer

Parameters:

parent - the Composite to use as a parent

Returns:

the created control

convert

protected Object convert(org.eclipse.swt.widgets.Text text,
                         org.eclipse.emf.ecore.EDataType attributeType,
                         String value)
                  throws DatabindingFailedException

Convert the given value from target to model.

Parameters:

text - the Text control

attributeType - the model data type

value - the target value to convert

Returns:

the converted value

Throws:

DatabindingFailedException - in case the databinding failed

Since:

1.13

getTextMessage

protected String getTextMessage()

Returns the text which should be set as the message text on the Text field.

Returns:

the string to show as the message

Since:

1.6

bindValue

protected org.eclipse.core.databinding.Binding bindValue(org.eclipse.swt.widgets.Control text,
                                                         org.eclipse.core.databinding.observable.value.IObservableValue modelValue,
                                                         org.eclipse.core.databinding.DataBindingContext dataBindingContext,
                                                         org.eclipse.core.databinding.UpdateValueStrategy targetToModel,
                                                         org.eclipse.core.databinding.UpdateValueStrategy modelToTarget)

Creates a focus out binding for this control.

Parameters:

text - the Text to bind

modelValue - the IObservableValue to bind

dataBindingContext - the DataBindingContext to use

targetToModel - the UpdateValueStrategy from target to Model

modelToTarget - the UpdateValueStrategy from model to target

Returns:

the created Binding

useOnModifyDatabinding

protected boolean useOnModifyDatabinding()

Whether SWT.Modify or SWT.FocusOut shall be used as the target databinding trigger.

Returns:

true if Modify should be used, false otherwise

Since:

1.9

createTooltipBinding

protected org.eclipse.core.databinding.Binding createTooltipBinding(org.eclipse.swt.widgets.Control text,
                                                                    org.eclipse.core.databinding.observable.value.IObservableValue modelValue,
                                                                    org.eclipse.core.databinding.DataBindingContext dataBindingContext,
                                                                    org.eclipse.core.databinding.UpdateValueStrategy targetToModel,
                                                                    org.eclipse.core.databinding.UpdateValueStrategy modelToTarget)

Creates a tooltip binding for this control.

Parameters:

text - the Text to bind

modelValue - the IObservableValue to bind

dataBindingContext - the DataBindingContext to use

targetToModel - the UpdateValueStrategy from target to Model

modelToTarget - the UpdateValueStrategy from model to target

Returns:

the created Binding

getTextWidgetStyle

protected int getTextWidgetStyle()

The style to apply to the text widget. This can be changed by the concrete classes.

Returns:

the style to apply

getEMFFormsEditSupport

protected EMFFormsEditSupport getEMFFormsEditSupport()

Returns:

the EMFFormsEditSupport

Since:

1.10

getDefaultAlignment

protected int getDefaultAlignment()

Return the default alignment value for this renderer.

Returns:

the alignment to use if no style was defined

getTextVariantID

protected String getTextVariantID()

The VariantId to use e.g. for RAP

Returns:

the String identifying this control

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 SimpleControlSWTRenderer

Parameters:

gridCell - the SWTGridCell to enable/disable

control - the Control to enable/disable

enabled - true if control should be enabled, false otherwise

getTextFromTextField

protected String getTextFromTextField(org.eclipse.swt.widgets.Text text,
                                      org.eclipse.emf.ecore.EDataType attributeType)

Gets the text displayed in the textfield.

Parameters:

text - the Text

attributeType - the EDataType

Returns:

the string displayed in the Text

Since:

1.13

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

setValidationColor

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

Description copied from class: SimpleControlSWTRenderer

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

Overrides:

setValidationColor in class SimpleControlSWTRenderer

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)

Description copied from class: SimpleControlSWTRenderer

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

Overrides:

setValidationForegroundColor in class SimpleControlSWTRenderer

Parameters:

control - the control to set the color on

validationColor - the validation color to set

isUnsetButtonLeftOfControlComposite

protected boolean isUnsetButtonLeftOfControlComposite()

Returns whether the unset button is placed left of the control composite containing the text field.

Returns:

true if the control is unsettable and the unset button is left of the text field, false otherwise

Since:

1.14

getControlCompositeFromControl

protected org.eclipse.swt.widgets.Control getControlCompositeFromControl(org.eclipse.swt.widgets.Control control)

Returns the control composite that contains the text field from the parent composite created by the SimpleControlSWTRenderer.

Parameters:

control - The edit control created by the SimpleControlSWTRenderer

Returns:

the control composite containing the text field

Since:

1.14