InputDialog Java doc bugs

tomas.klems · August 16, 2024, 2:04pm

Hi all,
for me working with “InputDialog d = dialogs.createInputDialog(…”
gives me really hard times…

I just want very basic Input Dialog with one input line and OK CANCEL buttons with Esc and ENTER shortcuts. I still did not get working after several hours…

Anyway, the JavaDoc shows an example.
In the example following lines are incorrect and not working.

InputDialog inputDialog = event.getInputDialog();
.withIcon(VaadinIcon.CLOSE.create())

There is no event.getInputDialog()
There is no VaadinIcon.CLOSE.

Please fix it and make correct working example.
Thank you.
Regards
Tomas

github.com

jmix-framework/jmix/blob/c0b95eb2c8dc7e6c8a2328f598d8257ba5c8c736/jmix-flowui/flowui/src/main/java/io/jmix/flowui/Dialogs.java#L234

      
        
             * @see #withResponsiveSteps(List)
             */
            InputDialogBuilder withLabelsPosition(LabelsPosition labelsPosition);
            
            
/**
             * Add close listener to the dialog. See close actions for {@link DialogActions} in {@link InputDialog}.
             *
             * @param listener close listener to add
             * @return builder
             */
            InputDialogBuilder withCloseListener(ComponentEventListener<InputDialog.InputDialogCloseEvent> listener);
            
            
/**
             * Sets dialog actions.
             * <p>
             * Note, if there is no actions are set input dialog will use {@link DialogActions#OK_CANCEL} by default.
             * </p>
             * Example:
             * <pre>{@code
             *  dialogs.createInputDialog(this)
             *         .withHeader("Dialog header")

chicojeff · August 17, 2024, 2:23pm

I have been successful using the documentation on Dialogs. There is an assumption the code runs within your view controller.

https://docs.jmix.io/jmix/flow-ui/dialogs.html#input-dialog

d.kremnev · August 19, 2024, 5:52am

Hi!

I created a task to update examples in JavaDocs: Fix javadoc examples in Dialogs · Issue #3615 · jmix-framework/jmix · GitHub
Thanks for your report.

Regards,
Dmitriy