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

Interface EMFFormsRevealService

  • All Known Implementing Classes:
    EMFFormsRevealServiceImpl
    public interface EMFFormsRevealService
    A service that mediates requests to reveal (navigate to) objects in an EMF Forms Editor with providers that know how to fulfil those requests.
    Since:
    1.22

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addRevealProvider​(EMFFormsRevealProvider provider)
      Register a reveal provider.
      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.

    • Method Detail

      • reveal

        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. Effectively equivalent to reveal(EObject, VElement) in the topmost scope (the root VView) of the context.
        Parameters:
        object - an object to reveal
        Returns:
        true if the object was revealed; false, otherwise

      • reveal

        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. Effectively equivalent to reveal(EObject, EStructuralFeature, VElement) in the topmost scope (the root VView) of the context.
        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

        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. Most applications will not need to interact with reveal steps directly but only through the reveal(EObject) API; reveal providers may need this API to delegate a drill down.
        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

        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. Most applications will not need to interact with reveal steps directly but only through the reveal(EObject, EStructuralFeature) API; reveal providers may need this API to delegate a drill down.
        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

      • addRevealProvider

        void addRevealProvider​(EMFFormsRevealProvider provider)
        Register a reveal provider.
        Parameters:
        provider - the reveal provider to register

      • removeRevealProvider

        void removeRevealProvider​(EMFFormsRevealProvider provider)
        Unregister a reveal provider.
        Parameters:
        provider - the reveal provider to unregister