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

Interface RevealHelper

public interface RevealHelper

Helper utility for common revealing patterns.

Since:

1.22

Method Summary

Modifier and Type	Method and Description
RevealStep	defer(Object deferredStep) Create a deferred reveal step that will attempt to reveal the domain model object in the current context.
default RevealStep	drillDown(Object drillDownStep) Create an intermediate step that drills down into the best fitting of the children of the view-model element in the current scope.
RevealStep	drillDown(Object drillDownStep, Object childrenFunction) Create an intermediate step that drills down into the best fitting of the children of the view-model element in the current scope.
RevealStep	masterDetail(Object masterStep, Object masterFunction) Create a master/detail reveal step that will reveal the master of the object to be revealed in the current context and then reveal that detail object, if it is a detail of some master.

Method Detail

drillDown

default RevealStep drillDown(Object drillDownStep)

Create an intermediate step that drills down into the best fitting of the children of the view-model element in the current scope.

Parameters:

drillDownStep - a computation of the drill-down step. Must have a method annotated with @Reveal and result type conforming to RevealStep

Returns:

the intermediate drill-down step

See Also:

drillDown(Object, Object)

drillDown

RevealStep drillDown(Object drillDownStep,
                     Object childrenFunction)

Create an intermediate step that drills down into the best fitting of the children of the view-model element in the current scope. In addition to the usual injections, the drill-down step computation is also provided the RevealStep that is the next step in the sequence, revealing the object in whatever child of the parent element the computed step reveals.

Parameters:

drillDownStep - a computation of the drill-down step. Must have a method annotated with @Reveal and result type conforming to RevealStep

childrenFunction - an optional function returning the subset of the element's children to consider for drilling down into. If omitted, all of the EObject.eContents() of the element that are VElements are implied. Must have a method annotated with @DrillDown and result type conforming to Iterable<? extends VElement>

Returns:

the intermediate drill-down step

defer

RevealStep defer(Object deferredStep)

Create a deferred reveal step that will attempt to reveal the domain model object in the current context.

Parameters:

deferredStep - a computation of the deferred reveal step. Must have a method annotated with @Reveal and result type conforming to RevealStep

Returns:

the deferred terminal reveal step

masterDetail

RevealStep masterDetail(Object masterStep,
                        Object masterFunction)

Create a master/detail reveal step that will reveal the master of the object to be revealed in the current context and then reveal that detail object, if it is a detail of some master.

Parameters:

masterStep - in the case that a master object is found to reveal, a computation of the reveal step for the master selection. Must have a method annotated with @Reveal and result type conforming to RevealStep

masterFunction - a function to compute the master object of which the object is a detail in the presentation of the given element. If the function returns either the input EObject domain model object or null, then that input is considered to be a master itself, and not a detail. Must have a method annotated with @DrillUp and result type conforming to EObject

Returns:

the master/detail reveal step