org.eclipse.emfforms.spi.core.services.controlmapper

Interface EMFFormsSettingToControlMapper

All Known Implementing Classes:

SettingToControlMapperImpl

public interface EMFFormsSettingToControlMapper

A mapping between UniqueSettings and Sets of VControls.

Since:

1.8

Author:

Lucas Koehler

Method Summary

Modifier and Type	Method and Description
void	checkAndUpdateSettingToControlMapping(org.eclipse.emf.ecore.EObject eObject) Checks and updates the mapping for the given EObject.
Set<VControl>	getControlsFor(org.eclipse.emf.ecore.EStructuralFeature.Setting setting) Returns all controls which are associated with the provided EStructuralFeature.Setting.
Set<VElement>	getControlsFor(UniqueSetting setting) Returns all controls which are associated with the provided UniqueSetting.
Collection<org.eclipse.emf.ecore.EObject>	getEObjectsWithSettings() Returns a collection of all EObjects which have a mapped setting.
Set<UniqueSetting>	getSettingsForControl(VControl control) Returns a collection of all settings for the given control.
boolean	hasControlsFor(org.eclipse.emf.ecore.EObject eObject) Checks whether any feature of this EObject has a registered control.
void	updateControlMapping(VControl vControl) Updates the setting to control mapping for the given VControl.
void	vControlAdded(VControl vControl) Adds a VControl to the setting to control mapping.
void	vControlRemoved(VControl vControl) Removes a VControl from the setting to control mapping.

Method Detail

getControlsFor

Set<VControl> getControlsFor(org.eclipse.emf.ecore.EStructuralFeature.Setting setting)

Returns all controls which are associated with the provided EStructuralFeature.Setting. The EStructuralFeature.Setting is converted to a UniqueSetting.

Parameters:

setting - the EStructuralFeature.Setting to search controls for

Returns:

the Set of all controls associated with the provided setting or null if no controls can be found

getControlsFor

Set<VElement> getControlsFor(UniqueSetting setting)

Returns all controls which are associated with the provided UniqueSetting.

Parameters:

setting - the UniqueSetting to search controls for

Returns:

the Set of all controls associated with the provided setting or null if no controls can be found

updateControlMapping

void updateControlMapping(VControl vControl)

Updates the setting to control mapping for the given VControl.

Parameters:

vControl - The VControl

vControlRemoved

void vControlRemoved(VControl vControl)

Removes a VControl from the setting to control mapping.

Parameters:

vControl - The VControl to remove

vControlAdded

void vControlAdded(VControl vControl)

Adds a VControl to the setting to control mapping.

Parameters:

vControl - The VControl to add

checkAndUpdateSettingToControlMapping

void checkAndUpdateSettingToControlMapping(org.eclipse.emf.ecore.EObject eObject)

Checks and updates the mapping for the given EObject.

Parameters:

eObject - The EObject

hasControlsFor

boolean hasControlsFor(org.eclipse.emf.ecore.EObject eObject)

Checks whether any feature of this EObject has a registered control.

Parameters:

eObject - the EObject to check

Returns:

true if there is at least one control for any feature of the given EObject, false otherwise

Since:

1.9

getEObjectsWithSettings

Collection<org.eclipse.emf.ecore.EObject> getEObjectsWithSettings()

Returns a collection of all EObjects which have a mapped setting.

Returns:

the EObjects

Since:

1.9

getSettingsForControl

Set<UniqueSetting> getSettingsForControl(VControl control)

Returns a collection of all settings for the given control.

Parameters:

control - the control to get the settings for

Returns:

the unique settings for the given control