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

Interface RevealStep

public interface RevealStep

A step in the progressive reveal of an object.

Since:

1.22

Field Summary

Fields

Modifier and Type	Field and Description
static RevealStep	FAILED The step indicating failure to reveal the object.

Method Summary

Modifier and Type	Method and Description
RevealStep	drillDown() Drills down into me to reveal the next step in the nested reveal.
static RevealStep	drillDown(VElement viewModel, org.eclipse.emf.ecore.EObject domainModel, RevealStep nextStep) Create an intermediate step that drills down into another step.
static RevealStep	drillDown(VElement viewModel, org.eclipse.emf.ecore.EObject domainModel, RevealStep nextStep, Runnable revealAction) Create an intermediate step that reveals some kind of container and drills down into another step.
static RevealStep	fail() Obtain a reveal failure step that signals absence of any UI element that can be activated to reveal the object.
org.eclipse.emf.ecore.EObject	getDomainModel() Query the domain object that I reveal in my view model element.
org.eclipse.emf.ecore.EStructuralFeature	getFeature() Query the feature that I reveal, if any.
RevealStepKind	getType() Query the type of reveal step that I am.
VElement	getViewModel() Query the view model element in which I reveal my domain model.
default void	ifPresent(Consumer<? super RevealStep> action) Invoke an action on me if I am not failed.
static Predicate<RevealStep>	is(RevealStepKind type) Obtain a predicate that matches reveal steps of a particular type.
default boolean	isDone() Query whether I am a non-intermediate reveal step.
default boolean	isFailed() Query whether I am a failed reveal step.
static Comparator<RevealStep>	preferredOrdering() Obtain a comparator that sorts reveal steps in preferential order by type, with the RevealStepKind.TERMINAL the most preferred and RevealStepKind.FAILED the least preferred.
void	reveal() Reveal my domain object in my view model element.
static RevealStep	reveal(VElement viewModel, org.eclipse.emf.ecore.EObject domainModel, org.eclipse.emf.ecore.EStructuralFeature feature, Runnable revealAction) Create a terminal step that reveals a feature of the object in the editor UI.
static RevealStep	reveal(VElement viewModel, org.eclipse.emf.ecore.EObject domainModel, Runnable revealAction) Create a terminal step that reveals the object in the editor UI.

Field Detail

FAILED

static final RevealStep FAILED

The step indicating failure to reveal the object.

See Also:

RevealStepKind.FAILED, fail()

Method Detail

getType

RevealStepKind getType()

Query the type of reveal step that I am.

Returns:

my type

isFailed

default boolean isFailed()

Query whether I am a failed reveal step.

Returns:

whether I represent failure to reveal the requested object

isDone

default boolean isDone()

Query whether I am a non-intermediate reveal step.

Returns:

true if there is no further progress to be made in revealing; false, otherwise

getViewModel

VElement getViewModel()

Query the view model element in which I reveal my domain model.

Returns:

my view model scope, or null if I am failed

getDomainModel

org.eclipse.emf.ecore.EObject getDomainModel()

Query the domain object that I reveal in my view model element.

Returns:

my domain model scope, or null if I am failed

getFeature

org.eclipse.emf.ecore.EStructuralFeature getFeature()

Query the feature that I reveal, if any. If I am not a terminal step, then I should not reveal any feature.

Returns:

the feature that I reveal, or null if none or if I am failed

drillDown

RevealStep drillDown()

Drills down into me to reveal the next step in the nested reveal.

Returns:

the next step in the progressive reveal, or null if I am the terminal step

Throws:

IllegalStateException - if I am failed

reveal

void reveal()

Reveal my domain object in my view model element.

Throws:

IllegalStateException - if I am failed

ifPresent

default void ifPresent(Consumer<? super RevealStep> action)

Invoke an action on me if I am not failed.

Parameters:

action - an action to invoke

drillDown

static RevealStep drillDown(VElement viewModel,
                            org.eclipse.emf.ecore.EObject domainModel,
                            RevealStep nextStep)

Create an intermediate step that drills down into another step.

Parameters:

viewModel - the view model element that is rendered and revealed

domainModel - the domain model object that is revealed in that view

nextStep - the next step to drill down into in the reveal operation

Returns:

the intermediate reveal step

drillDown

static RevealStep drillDown(VElement viewModel,
                            org.eclipse.emf.ecore.EObject domainModel,
                            RevealStep nextStep,
                            Runnable revealAction)

Create an intermediate step that reveals some kind of container and drills down into another step.

Parameters:

viewModel - the view model element that is rendered and revealed

domainModel - the domain model object that is revealed in that view

nextStep - the next step to drill down into in the reveal operation

revealAction - a rendering-specific action that actually reveals the rendered container element in the UI

Returns:

the intermediate reveal step

reveal

static RevealStep reveal(VElement viewModel,
                         org.eclipse.emf.ecore.EObject domainModel,
                         Runnable revealAction)

Create a terminal step that reveals the object in the editor UI.

Parameters:

viewModel - the view model element that is rendered and revealed

domainModel - the domain model object that is revealed in that view

revealAction - a rendering-specific action that actually reveals the rendered element that presents the object in the UI

Returns:

the terminal reveal step

reveal

static RevealStep reveal(VElement viewModel,
                         org.eclipse.emf.ecore.EObject domainModel,
                         org.eclipse.emf.ecore.EStructuralFeature feature,
                         Runnable revealAction)

Create a terminal step that reveals a feature of the object in the editor UI.

Parameters:

viewModel - the view model element that is rendered and revealed

domainModel - the domain model object that is revealed in that view

feature - the feature of the domain model object that I specfically revealed

revealAction - a rendering-specific action that actually reveals the rendered element that presents the object in the UI

Returns:

the terminal reveal step

fail

static RevealStep fail()

Obtain a reveal failure step that signals absence of any UI element that can be activated to reveal the object.

Returns:

the failed reveal step

See Also:

FAILED

is

static Predicate<RevealStep> is(RevealStepKind type)

Obtain a predicate that matches reveal steps of a particular type.

Parameters:

type - the type of step to match

Returns:

the predicate

See Also:

getType()

preferredOrdering

static Comparator<RevealStep> preferredOrdering()

Obtain a comparator that sorts reveal steps in preferential order by type, with the RevealStepKind.TERMINAL the most preferred and RevealStepKind.FAILED the least preferred.

Returns:

the ordering

See Also:

getType()