Package io.jmix.dynmodelflowui.impl

Class DynamicViewHandlerSuggestionProvider

java.lang.Object

io.jmix.dynmodelflowui.impl.DynamicViewHandlerSuggestionProvider

@Component("dynmod_DynamicViewHandlerSuggestionProvider")
public class DynamicViewHandlerSuggestionProvider
extends Object

Provides code completion for a dynamic view behavior handler expression, in the role JpqlUiSuggestionProvider plays for JPQL queries. Used by the Admin UI handler editor as the Suggester of its expression editor.

What is offered depends on where the cursor stands, as classified by DynamicViewHandlerExpressionParser: the sandbox API at the root and after a dot, and the values valid in the slot when the cursor is inside a string argument — component ids for the components facade, operation names for services.call, and the view's handler names for the follow-up of dialogs.confirm. Keys of the state facade are invented by the expression author, so nothing is offered for them.

The typed prefix is not filtered here; the code editor filters the returned options client-side, the same way it does for JPQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DynamicViewHandlerSuggestionProvider.EditorContext	What the editor knows about the handler being edited and cannot be derived from the expression.

Field Summary

Fields

Modifier and Type	Field	Description
protected DynamicViewApiIntrospector	apiIntrospector
protected static final String	CALL_METHOD
protected static final String	COMPONENTS_FACADE
protected static final int	CONFIRM_HANDLER_ARGUMENT	The argument of dialogs.confirm(header, text, handlerName) that names the follow-up handler.
protected static final String	CONFIRM_METHOD
protected static final String	DIALOGS_FACADE
protected static final String	ENTITY_MEMBER
protected DynamicViewEntityAttributeProvider	entityAttributeProvider
protected DynamicModelOperationRegistry	operationRegistry
protected DynamicViewHandlerExpressionParser	parser
protected static final String	SERVICES_FACADE

Constructor Summary

Constructors

Constructor	Description
DynamicViewHandlerSuggestionProvider()

Method Summary

Modifier and Type	Method	Description
protected List<Suggestion>	argumentSuggestions(DynamicViewHandlerExpressionParser.Position position, DynamicViewHandlerSuggestionProvider.EditorContext editorContext)
protected List<Suggestion>	componentSuggestions(List<DynamicViewComponentIdProvider.ComponentInfo> components)	The XML tag is shown as the hint, as in the component id combo of the same dialog.
protected @Nullable List<String>	entityPath(String receiverPath)
List<Suggestion>	getSuggestions(Suggester.SuggestionContext context, DynamicViewHandlerSuggestionProvider.EditorContext editorContext)	Returns the suggestions for the current editor state.
protected List<Suggestion>	handlerNameSuggestions(List<String> handlerNames)
protected List<Suggestion>	memberSuggestions(String receiverPath, DynamicViewHandlerSuggestionProvider.EditorContext editorContext)
protected List<Suggestion>	operationSuggestions()
protected String	parameterTypes(Method method)
protected List<Suggestion>	rootSuggestions(DynamicViewHandlerSuggestionProvider.EditorContext editorContext)	The entity and isNew() alongside the facade names.
protected List<Suggestion>	suggest(Suggester.SuggestionContext context, DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

Methods inherited from class java.lang.Object

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

Field Details

ENTITY_MEMBER

protected static final String ENTITY_MEMBER

See Also:

• Constant Field Values

COMPONENTS_FACADE

protected static final String COMPONENTS_FACADE

See Also:

• Constant Field Values

SERVICES_FACADE

protected static final String SERVICES_FACADE

See Also:

• Constant Field Values

DIALOGS_FACADE

protected static final String DIALOGS_FACADE

See Also:

• Constant Field Values

CALL_METHOD

protected static final String CALL_METHOD

See Also:

• Constant Field Values

CONFIRM_METHOD

protected static final String CONFIRM_METHOD

See Also:

• Constant Field Values

CONFIRM_HANDLER_ARGUMENT

protected static final int CONFIRM_HANDLER_ARGUMENT

The argument of dialogs.confirm(header, text, handlerName) that names the follow-up handler.

See Also:

• Constant Field Values

parser

@Autowired
protected DynamicViewHandlerExpressionParser parser

apiIntrospector

@Autowired
protected DynamicViewApiIntrospector apiIntrospector

entityAttributeProvider

@Autowired
protected DynamicViewEntityAttributeProvider entityAttributeProvider

operationRegistry

@Autowired
protected DynamicModelOperationRegistry operationRegistry

Constructor Details

DynamicViewHandlerSuggestionProvider

public DynamicViewHandlerSuggestionProvider()

Method Details

getSuggestions

public List<Suggestion> getSuggestions(Suggester.SuggestionContext context,
 DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

Returns the suggestions for the current editor state. Never throws: the code runs on every keystroke that opens the popup, and an empty list only leaves the editor without suggestions.

Parameters:

context - the current state of the client-side of the editor

editorContext - what the editor knows about the handler being edited

suggest

protected List<Suggestion> suggest(Suggester.SuggestionContext context,
 DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

rootSuggestions

protected List<Suggestion> rootSuggestions(DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

The entity and isNew() alongside the facade names. The entity is reported with the name of the entity it holds rather than as a plain object, which is all the sandbox API can tell.

memberSuggestions

protected List<Suggestion> memberSuggestions(String receiverPath,
 DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

entityPath

protected @Nullable List<String> entityPath(String receiverPath)

Returns:

the reference attributes traversed after entity, or null when the path does not start at the entity

argumentSuggestions

protected List<Suggestion> argumentSuggestions(DynamicViewHandlerExpressionParser.Position position,
 DynamicViewHandlerSuggestionProvider.EditorContext editorContext)

componentSuggestions

protected List<Suggestion> componentSuggestions(List<DynamicViewComponentIdProvider.ComponentInfo> components)

The XML tag is shown as the hint, as in the component id combo of the same dialog.

operationSuggestions

protected List<Suggestion> operationSuggestions()

parameterTypes

protected String parameterTypes(Method method)

handlerNameSuggestions

protected List<Suggestion> handlerNameSuggestions(List<String> handlerNames)