ECPAbstractControl (ecp-parent 1.10.0-SNAPSHOT API)

java.lang.Object
- org.eclipse.emf.ecp.edit.spi.ECPAbstractControl

Direct Known Subclasses:

SWTControl

Deprecated.
```
@Deprecated
public abstract class ECPAbstractControl
extends Object
```
The ECPAbstractControl is the abstract class describing a control. This class provides the necessary common access methods.

Author:

Eugen Neufeld

Constructor Summary

Constructors
Constructor and Description

ECPAbstractControl()
Deprecated.

Constructors
Constructor and Description
`ECPAbstractControl()` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`applyValidation(VDiagnostic diagnostic)` Deprecated. Override this method in order to handle validation.
`protected void`	`backwardCompatibleHandleValidation()` Deprecated. Helper method to keep the old validation.
`void`	`dispose()` Deprecated. Disposes the control.
`protected void`	`enabledmentChanged(boolean enabled)` Deprecated. Notifies a control, that its enablement state has changed.
`protected VControl`	`getControl()` Deprecated. Return the `VControl`.
`org.eclipse.core.databinding.DataBindingContext`	`getDataBindingContext()` Deprecated. Returns a `DataBindingContext` for this control.
`protected VDomainModelReference`	`getDomainModelReference()` Deprecated. Returns the `VDomainModelReference` set for this control.
`protected org.eclipse.emf.edit.domain.EditingDomain`	`getEditingDomain()` Deprecated.
`protected org.eclipse.emf.edit.domain.EditingDomain`	`getEditingDomain(org.eclipse.emf.ecore.EStructuralFeature.Setting setting)` Deprecated. Returns the `EditingDomain` for the provided `EStructuralFeature.Setting`.
`org.eclipse.emf.ecore.EStructuralFeature.Setting`	`getFirstSetting()` Deprecated. Returns the first setting for this control.
`org.eclipse.emf.ecore.EStructuralFeature`	`getFirstStructuralFeature()` Deprecated. Return the `EStructuralFeature` of this control.
`org.eclipse.emf.edit.provider.IItemPropertyDescriptor`	`getItemPropertyDescriptor(org.eclipse.emf.ecore.EStructuralFeature.Setting setting)` Deprecated. Return the `IItemPropertyDescriptor` describing this `EStructuralFeature.Setting`.
`protected Locale`	`getLocale()` Deprecated. Returns the current Locale.
`protected <T> T`	`getService(Class<T> serviceClass)` Deprecated. This method allows to get a service from the view model context.
`protected ViewModelContext`	`getViewModelContext()` Deprecated. Return the `ViewModelContext`.
`void`	`handleValidation(org.eclipse.emf.common.util.Diagnostic diagnostic)` Deprecated.
`void`	`init(ViewModelContext viewModelContext, VControl control)` Deprecated. This method is called by the framework to instantiate the `ECPAbstractControl`.
`protected boolean`	`isEmbedded()` Deprecated. Whether a control is embedded.
`protected void`	`postInit()` Deprecated. Overwrite this method to implement control specific operations which must be executed after the init but before the rendering.
`void`	`resetValidation()` Deprecated.
`void`	`setEditable(boolean isEditable)` Deprecated.
`void`	`setEmbedded(boolean embedded)` Deprecated. Sets whether this control is used as an embedded control.
`boolean`	`showLabel()` Deprecated. use the labelAlignment of the control model element

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ECPAbstractControl
```
public ECPAbstractControl()
```
    Deprecated.
- Method Detail
  - init
```
public final void init(ViewModelContext viewModelContext,
                       VControl control)
```
    Deprecated.
    
    This method is called by the framework to instantiate the ECPAbstractControl.
    
    Parameters:
    
    viewModelContext - the ViewModelContext to use by this ECPAbstractControl.
    
    control - the VControl of this control
    
    Since:
    
    1.2
  - postInit
```
protected void postInit()
```
    Deprecated.
    
    Overwrite this method to implement control specific operations which must be executed after the init but before the rendering.
    
    Since:
    
    1.2
  - enabledmentChanged
```
protected void enabledmentChanged(boolean enabled)
```
    Deprecated.
    
    Notifies a control, that its enablement state has changed.
    
    Parameters:
    
    enabled - the new enablement value
    
    Since:
    
    1.2
  - applyValidation
```
protected void applyValidation(VDiagnostic diagnostic)
```
    Deprecated.
    
    Override this method in order to handle validation.
    
    Parameters:
    
    diagnostic - the current VDiagnostic
    
    Since:
    
    1.2
  - getItemPropertyDescriptor
```
public org.eclipse.emf.edit.provider.IItemPropertyDescriptor getItemPropertyDescriptor(org.eclipse.emf.ecore.EStructuralFeature.Setting setting)
```
    Deprecated.
    
    Return the IItemPropertyDescriptor describing this EStructuralFeature.Setting.
    
    Parameters:
    
    setting - the EStructuralFeature.Setting to use for identifying the IItemPropertyDescriptor.
    
    Returns:
    
    the IItemPropertyDescriptor
    
    Since:
    
    1.2
  - getControl
```
protected final VControl getControl()
```
    Deprecated.
    
    Return the VControl.
    
    Returns:
    
    the VControl of this control
    
    Since:
    
    1.2
  - getViewModelContext
```
protected final ViewModelContext getViewModelContext()
```
    Deprecated.
    
    Return the ViewModelContext.
    
    Returns:
    
    the ViewModelContext of this control
    
    Since:
    
    1.2
  - getFirstSetting
```
public final org.eclipse.emf.ecore.EStructuralFeature.Setting getFirstSetting()
```
    Deprecated.
    
    Returns the first setting for this control.
    
    Returns:
    
    the first Setting or throws an IllegalArgumentException if no settings can be found
    
    Since:
    
    1.2
  - getFirstStructuralFeature
```
public final org.eclipse.emf.ecore.EStructuralFeature getFirstStructuralFeature()
```
    Deprecated.
    
    Return the EStructuralFeature of this control.
    
    Returns:
    
    the EStructuralFeature
    
    Since:
    
    1.2
  - getDataBindingContext
```
public final org.eclipse.core.databinding.DataBindingContext getDataBindingContext()
```
    Deprecated.
    
    Returns a DataBindingContext for this control.
    
    Returns:
    
    the DataBindingContext
    
    Since:
    
    1.1
  - dispose
```
public void dispose()
```
    Deprecated.
    
    Disposes the control. A control which needs specific dispose handling must still call super.dispose.
    
    Since:
    
    1.1
  - isEmbedded
```
protected final boolean isEmbedded()
```
    Deprecated.
    
    Whether a control is embedded. An embedded control can be rendered in an other fashion then an not embedded version.
    
    Returns:
    
    true if the control is embedded in another control
  - setEmbedded
```
public final void setEmbedded(boolean embedded)
```
    Deprecated.
    
    Sets whether this control is used as an embedded control.
    
    Parameters:
    
    embedded - whether the control is used as an embedded control
  - getEditingDomain
```
protected final org.eclipse.emf.edit.domain.EditingDomain getEditingDomain(org.eclipse.emf.ecore.EStructuralFeature.Setting setting)
```
    Deprecated.
    
    Returns the EditingDomain for the provided EStructuralFeature.Setting.
    
    Parameters:
    
    setting - the provided EStructuralFeature.Setting
    
    Returns:
    
    the EditingDomain of this EStructuralFeature.Setting
    
    Since:
    
    1.2
  - getService
```
protected final <T> T getService(Class<T> serviceClass)
```
    Deprecated.
    
    This method allows to get a service from the view model context.
    
    Type Parameters:
    
    T - the type of the service
    
    Parameters:
    
    serviceClass - the type of the service to get
    
    Returns:
    
    the service instance
    
    Since:
    
    1.2
  - getLocale
```
protected final Locale getLocale()
```
    Deprecated.
    
    Returns the current Locale.
    
    Returns:
    
    the current Locale
    
    Since:
    
    1.2
  - getDomainModelReference
```
protected final VDomainModelReference getDomainModelReference()
```
    Deprecated.
    
    Returns the VDomainModelReference set for this control.
    
    Returns:
    
    the domainModelReference the VDomainModelReference of this control
    
    Since:
    
    1.2
  - getEditingDomain
```
@Deprecated
protected final org.eclipse.emf.edit.domain.EditingDomain getEditingDomain()
```
    Deprecated.
    
    Returns the EditingDomain for the set VDomainModelReference.
    
    Returns:
    
    the EditingDomain for this control
    
    Since:
    
    1.2
  - backwardCompatibleHandleValidation
```
protected void backwardCompatibleHandleValidation()
```
    Deprecated.
    
    Helper method to keep the old validation. Does nothing.
    
    Since:
    
    1.2
  - handleValidation
```
@Deprecated
public void handleValidation(org.eclipse.emf.common.util.Diagnostic diagnostic)
```
    Deprecated.
    
    Handle live validation.
    
    Parameters:
    
    diagnostic - of type Diagnostic
    
    Since:
    
    1.2
  - resetValidation
```
@Deprecated
public void resetValidation()
```
    Deprecated.
    
    Reset the validation status 'ok'.
    
    Since:
    
    1.2
  - showLabel
```
@Deprecated
public boolean showLabel()
```
    Deprecated. use the labelAlignment of the control model element
    
    Whether a label should be shown for this control.
    
    Returns:
    
    true if a label should be created, false otherwise
    
    Since:
    
    1.2
  - setEditable
```
@Deprecated
public void setEditable(boolean isEditable)
```
    Deprecated.
    
    Sets the state of the widget to be either editable or not.
    
    Parameters:
    
    isEditable - whether to set the widget editable
    
    Since:
    
    1.2

Class ECPAbstractControl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ECPAbstractControl

Method Detail

init

postInit

enabledmentChanged

applyValidation

getItemPropertyDescriptor

getControl

getViewModelContext

getFirstSetting

getFirstStructuralFeature

getDataBindingContext

dispose

isEmbedded

setEmbedded

getEditingDomain

getService

getLocale

getDomainModelReference

getEditingDomain

backwardCompatibleHandleValidation

handleValidation

resetValidation

showLabel

setEditable