Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve "Passing parameters to screen" section #734

Open
alexbudarov opened this issue Jul 29, 2020 · 2 comments
Open

Improve "Passing parameters to screen" section #734

alexbudarov opened this issue Jul 29, 2020 · 2 comments

Comments

@alexbudarov
Copy link
Member

alexbudarov commented Jul 29, 2020

Environment

Description of the bug or enhancement

We see from time to time questions from users about how to pass parameters to screens.
After taking a side look to this section, my personal opinion that it needs improvements:

  • I don't see clear enumeration that "you can do it by 3-4 the following different ways, pick the most convenient for you"
  • No sub-sectioning. The narrative quickly moves from one way to pass params to another one without full explanation. You need to fully and carefully read this chapter 2 times to understand all options.
  • No complete code samples. Working code samples is a must have! User should be able to copy-paste the code without careful reading. E.g. there are no example of screen controller code for "screen.setFancyMessage(message);" calling sample. Also generally you should start with code sample of the screen which is being opened first, because this is how most people develop code (valid first).
  • No mentioning of @WindowParam, though even CUBA developers still use this way, see this recently edited code: com.haulmont.reports.gui.report.history.ReportExecutionBrowser#filterByReports
@alexbudarov
Copy link
Member Author

Also mention or give link to separate section with samples how to add screen parameters for standard actions (CreateAction, EditAction, PickerField.LookupAction).

@alexbudarov
Copy link
Member Author

Also mention that you can also open screens by using screen facets (ScreenFacet, LookupScreenFacet etc)

A screen can be opened from the main menu, by navigating to a URL, by a standard action (when working with browse and edit entity screens), or programmatically from another screen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant