Package org.eclipse.emfforms.spi.core.services.label

Interface EMFFormsLabelProvider

All Known Implementing Classes:

EMFFormsLabelProviderDefaultImpl, EMFFormsLabelProviderImpl

public interface EMFFormsLabelProvider

The EMFFormsLabelProvider offers methods to get the display name and the description for a model object referenced by a VDomainModelReference as an IObservableValue. The reference can optionally be complemented by an EObject which is the root object of the VDomainModelReference. This enables to get the texts for a concrete instance.

Author:

Eugen Neufeld

Method Summary

Modifier and Type	Method	Description
org.eclipse.core.databinding.observable.value.IObservableValue	getDescription(VDomainModelReference domainModelReference)	Deprecated. This does not work with domain model references using segments.
org.eclipse.core.databinding.observable.value.IObservableValue	getDescription(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EClass rootEClass)	Returns the description of the referenced domain object resolved for the given root EClass.
org.eclipse.core.databinding.observable.value.IObservableValue	getDescription(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject rootObject)	Returns the description of the referenced domain object resolved for the given root EObject.
org.eclipse.core.databinding.observable.value.IObservableValue	getDisplayName(VDomainModelReference domainModelReference)	Deprecated. This does not work with domain model references using segments.
org.eclipse.core.databinding.observable.value.IObservableValue	getDisplayName(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EClass rootEClass)	Returns the display name of the referenced domain object resolved for the given root EClass.
org.eclipse.core.databinding.observable.value.IObservableValue	getDisplayName(VDomainModelReference domainModelReference, org.eclipse.emf.ecore.EObject rootObject)	Returns the display name of the referenced domain object resolved for the given root EObject.

Method Detail

getDisplayName

@Deprecated
org.eclipse.core.databinding.observable.value.IObservableValue getDisplayName(VDomainModelReference domainModelReference)
                                                                       throws NoLabelFoundException

Deprecated.

This does not work with domain model references using segments.

Returns the display name of the referenced domain object.

Important: Does not work with DMRs which use segments

Parameters:

domainModelReference - The VDomainModelReference referencing the domain object

Returns:

The display name as an IObservableValue

Throws:

NoLabelFoundException - if the display name cannot be retrieved

getDisplayName

org.eclipse.core.databinding.observable.value.IObservableValue getDisplayName(VDomainModelReference domainModelReference,
                                                                              org.eclipse.emf.ecore.EClass rootEClass)
                                                                       throws NoLabelFoundException

Returns the display name of the referenced domain object resolved for the given root EClass.

Parameters:

domainModelReference - The VDomainModelReference referencing the domain object

rootEClass - The root EClass which is used to resolve the given VDomainModelReference

Returns:

The display name as an IObservableValue

Throws:

NoLabelFoundException - if the display name cannot be retrieved

Since:

1.19

getDisplayName

org.eclipse.core.databinding.observable.value.IObservableValue getDisplayName(VDomainModelReference domainModelReference,
                                                                              org.eclipse.emf.ecore.EObject rootObject)
                                                                       throws NoLabelFoundException

Returns the display name of the referenced domain object resolved for the given root EObject.

Parameters:

domainModelReference - The VDomainModelReference referencing the domain object

rootObject - The root EObject which is used to resolve the given VDomainModelReference

Returns:

The display name as an IObservableValue

Throws:

NoLabelFoundException - if the display name cannot be retrieved

getDescription

@Deprecated
org.eclipse.core.databinding.observable.value.IObservableValue getDescription(VDomainModelReference domainModelReference)
                                                                       throws NoLabelFoundException

Deprecated.

This does not work with domain model references using segments.

Returns the description of the referenced domain object.

Important: Does not work with DMRs which use segments

Parameters:

domainModelReference - The VDomainModelReference referencing the model object

Returns:

The description as an IObservableValue

Throws:

NoLabelFoundException - if the description cannot be retrieved

getDescription

org.eclipse.core.databinding.observable.value.IObservableValue getDescription(VDomainModelReference domainModelReference,
                                                                              org.eclipse.emf.ecore.EClass rootEClass)
                                                                       throws NoLabelFoundException

Returns the description of the referenced domain object resolved for the given root EClass.

Parameters:

domainModelReference - The VDomainModelReference referencing the model object

rootEClass - The root EClass which is used to resolve the given VDomainModelReference

Returns:

The description as an IObservableValue

Throws:

NoLabelFoundException - if the description cannot be retrieved

Since:

1.19

getDescription

org.eclipse.core.databinding.observable.value.IObservableValue getDescription(VDomainModelReference domainModelReference,
                                                                              org.eclipse.emf.ecore.EObject rootObject)
                                                                       throws NoLabelFoundException

Returns the description of the referenced domain object resolved for the given root EObject.

Parameters:

domainModelReference - The VDomainModelReference referencing the model object

rootObject - The root EObject which is used to resolve the given VDomainModelReference

Returns:

The description as an IObservableValue

Throws:

NoLabelFoundException - if the description cannot be retrieved