Package org.eclipse.emfforms.internal.core.services.reveal

Class EMFFormsRevealServiceImpl

java.lang.Object

org.eclipse.emfforms.internal.core.services.reveal.EMFFormsRevealServiceImpl

All Implemented Interfaces:

EMFFormsRevealService

public class EMFFormsRevealServiceImpl
extends java.lang.Object
implements EMFFormsRevealService

Implementation of the EMF Forms reveal service.

Since:

1.22

Constructor Summary

Constructors

Constructor	Description
EMFFormsRevealServiceImpl(EMFFormsViewContext viewContext)	Initializes me with my view context.

Method Summary

Modifier and Type	Method	Description
void	addRevealProvider(EMFFormsRevealProvider provider)	Register a reveal provider.
protected EMFFormsViewContext	getViewContext(VElement element)	Get the nearest context for a view model element.
void	removeRevealProvider(EMFFormsRevealProvider provider)	Unregister a reveal provider.
boolean	reveal(org.eclipse.emf.ecore.EObject object)	Attempt to reveal an object in the most appropriate (by best effort) control in the current editor context.
boolean	reveal(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EStructuralFeature feature)	Attempt to reveal a feature of an object in the most appropriate (by best effort) control in the current editor context.
RevealStep	reveal(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EStructuralFeature feature, VElement scope)	Attempt to reveal a feature of an object in the most appropriate (by best effort) control within the given scope.
RevealStep	reveal(org.eclipse.emf.ecore.EObject object, VElement scope)	Attempt to reveal an object in the most appropriate (by best effort) control within the given scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EMFFormsRevealServiceImpl

public EMFFormsRevealServiceImpl(EMFFormsViewContext viewContext)

Initializes me with my view context.

Parameters:

viewContext - my view context

Method Detail

reveal

public boolean reveal(org.eclipse.emf.ecore.EObject object)

Description copied from interface: EMFFormsRevealService

Attempt to reveal an object in the most appropriate (by best effort) control in the current editor context. Effectively equivalent to EMFFormsRevealService.reveal(EObject, VElement) in the topmost scope (the root VView) of the context.

Specified by:

reveal in interface EMFFormsRevealService

Parameters:

object - an object to reveal

Returns:

true if the object was revealed; false, otherwise

reveal

public boolean reveal(org.eclipse.emf.ecore.EObject object,
                      org.eclipse.emf.ecore.EStructuralFeature feature)

Description copied from interface: EMFFormsRevealService

Attempt to reveal a feature of an object in the most appropriate (by best effort) control in the current editor context. Effectively equivalent to EMFFormsRevealService.reveal(EObject, EStructuralFeature, VElement) in the topmost scope (the root VView) of the context.

Specified by:

reveal in interface EMFFormsRevealService

Parameters:

object - an object to reveal

feature - a specific feature (implying a detail control) to reveal

Returns:

true if the object was revealed; false, otherwise

reveal

public RevealStep reveal(org.eclipse.emf.ecore.EObject object,
                         VElement scope)

Description copied from interface: EMFFormsRevealService

Attempt to reveal an object in the most appropriate (by best effort) control within the given scope. Most applications will not need to interact with reveal steps directly but only through the EMFFormsRevealService.reveal(EObject) API; reveal providers may need this API to delegate a drill down.

Specified by:

reveal in interface EMFFormsRevealService

Parameters:

object - an object to reveal

scope - a control within which to attempt to reveal the object

Returns:

a step-wise chain of operations to progressively reveal the object in the given scope, or a failed step if none

reveal

public RevealStep reveal(org.eclipse.emf.ecore.EObject object,
                         org.eclipse.emf.ecore.EStructuralFeature feature,
                         VElement scope)

Description copied from interface: EMFFormsRevealService

Attempt to reveal a feature of an object in the most appropriate (by best effort) control within the given scope. Most applications will not need to interact with reveal steps directly but only through the EMFFormsRevealService.reveal(EObject, EStructuralFeature) API; reveal providers may need this API to delegate a drill down.

Specified by:

reveal in interface EMFFormsRevealService

Parameters:

object - an object to reveal

feature - a specific feature (implying a detail control) to reveal

scope - a control within which to attempt to reveal the object

Returns:

a step-wise chain of operations to progressively reveal the object in the given scope, or a failed step if none

getViewContext

protected EMFFormsViewContext getViewContext(VElement element)

Get the nearest context for a view model element. This is either some active detail context or the root context that owns me.

Parameters:

element - a view-model element

Returns:

its most specific applicable context

addRevealProvider

public void addRevealProvider(EMFFormsRevealProvider provider)

Description copied from interface: EMFFormsRevealService

Register a reveal provider.

Specified by:

addRevealProvider in interface EMFFormsRevealService

Parameters:

provider - the reveal provider to register

removeRevealProvider

public void removeRevealProvider(EMFFormsRevealProvider provider)

Description copied from interface: EMFFormsRevealService

Unregister a reveal provider.

Specified by:

removeRevealProvider in interface EMFFormsRevealService

Parameters:

provider - the reveal provider to unregister