Apache Isis: How to implement your custom submit form or page properly?

Question

I'm new at Apache Isis and I'm stuck.

I want to create my own submit form with editable parameters for search some entities and a grid with search results below.

Firstly, I created @DomainObject(nature=Nature.VIEW_MODEL) with search results collection, parameters for search and @Action for search. After deeper research, I found out strict implementations for actions (For exapmle ActionParametersFormPanel). Can I use @Action and edit @DomainObject properties(my search parameters for action) without prompts? Can I implement it by layout.xml?

Then I tried to change a component as described here: 6.2 Replacing page elements, but I was confused which ComponentType and IModel should I use, maybe ComponentType.PARAMETERS and ActionModel or implement my own IModel for my case.

Should I implement my own Wicket page for search and register it by PageClassList interface, as described here: 6.3 Custom pages As I understood I need to replace page class for one of PageType, but which one should I change?

So, the question is how to implement such issues properly? Which way should I choose?

Thank you!

===================== UPDATE ===================

I've implemented HomePageViewModel in this way:

@DomainObject(
        nature = Nature.VIEW_MODEL,
        objectType = "homepage.HomePageViewModel"
)
@Setter @Getter
public class HomePageViewModel {

    private String id;
    private String type;

    public TranslatableString title() {
        return TranslatableString.tr("My custom search");
    }

    public List<SimpleObject> getObjects() {
        return simpleObjectRepository.listAll();
    }

    @Action
    public HomePageViewModel search(
            @ParameterLayout(named = "Id")
            String id,
            @ParameterLayout(named = "Type")
            String type
    ){
        setId(id);
        setType(type);
        // finding objects by entered parameters is not implemented yet
        return this;
    }

    @javax.inject.Inject
    SimpleObjectRepository simpleObjectRepository;
}   

And it works in this way:

I want to implement a built-in-ViewModel action with parameters without any dialog windows, smth like this:

1) Is it possible to create smth like ActionParametersFormPanel based on ComponentType.PARAMETERS and ActionModel and use this component as @Action in my ViewModel?

2) Or I should use, as you said, ComponentType.COLLECTION_CONTENTS? As I inderstand my search result grid and my search input panel will be like ONE my stub component?

Thank you.

Answer 1

We have a JIRA ticket in our JIRA to implement a filterable/searchable component, but it hasn't yet made it to the top of the list for implementation.

As an alternative, you could have a view model that provides the parameters you want to filter on as properties, with a table underneath. (I see you asked another question here on SO re properties on view models, so perhaps you are moving in that direction also... I've answered that question).

If you do want to have a stab at implementing that ticket, then the ComponentTYpe to use is COLLECTION_CONTENTS. If you take a look at the isisaddons, eg for excel or gmap3 then it might help get you started.

======= UPDATE TO ANSWER (based on update made to query) ==========

I have some good news for you. v1.15.0-SNAPSHOT, which should be released in the couple of weeks, has support for "inline prompts". You should find these give a user experience very similar to what you are after, with no further work needed on your part.

To try it out, check out the current trunk, and then load the simpleapp (in examples/application/simpleapp). You should see that editing properties and invoking actions uses the new inline prompt style.

HTH Dan