Review Request: JDK-8210361: Add images to docs for public API classes of controls
Hi, Please review the current state of the patch for: https://bugs.openjdk.java.net/browse/JDK-8210361 http://cr.openjdk.java.net/~nlisker/8210361/webrev.00/ Thanks, Nir
Re: JDK-8210361: Add images to docs for public API classes of controls
Hi Anirvan, A gallery will fit best in the tutorials. The page for UI controls [1] will be ideal in my opinion (put the gallery as the first link). About the screenshots: that page contains much more suitable screenshots in each control's page when it comes to a gallery. They are stylistic, show-off-ish, and present a wider range of possibilities and states for each control. The examples in the JavaDocs are minimalistic, with the point of showing how easy it is to create the control. They don't make for much of a gallery, but they do show the developer very quickly what that control they are looking at is for a WYSIWYG code example. I suggest you submit an RFE which relates to the general "update the tutorials" issue [2] (instead of the one I'm working on) and take the screenshots from those pages. [1] https://docs.oracle.com/javase/8/javafx/user-interface-tutorial/ui_controls.htm#JFXUI336 [2] https://bugs.openjdk.java.net/browse/JDK-8210360 - Nir On Wed, Sep 12, 2018 at 10:33 PM Anirvan Sarkar wrote: > Hi Nir, > > Thanks for this RFE. > > Now other UI toolkits like GTK and QT have a separate gallery of > controls[1][2]. > > I was considering to add something similar in JavaFX but I never got > around to start working on it, mostly due to all the screenshots which is > needed to be taken beforehand ! > > Since you will now take images of all the controls, you can consider to > add a gallery in this RFE itself. > > But if you don't want then someone else (me) can volunteer to do this once > this RFE is merged. > > Let me know what you decide :-) > > [1] : https://developer.gnome.org/gtk4/stable/ch03.html > [2] : http://doc.qt.io/archives/qt-4.8/gallery.html > > > On Thu 13 Sep, 2018, 12:07 AM Kevin Rushforth, > wrote: > >> Agreed. For simple controls like checkbox, button, etc., it makes sense >> to use an undecorated Stage. It's less busy and puts the emphasis on the >> control being illustrated. >> >> -- Kevin >> >> >> On 9/12/2018 7:57 AM, Pedro Duque Vieira wrote: >> > Yes I agree with you. Controls on which their window decorations are a >> part >> > of them, should show up with them. If those decorations change >> depending on >> > the platform their running, I would put a note saying that. >> > >> > The vast majority of controls don't belong to that category. >> > >> > Cheers, >> > >> > On Wed, Sep 12, 2018 at 3:51 PM Nir Lisker wrote: >> > >> >> That's sensible, though for Alert and the like I think they should >> stay as >> >> it's effectively part of the control. >> >> >> >> On Wed, Sep 12, 2018 at 4:19 PM Pedro Duque Vieira < >> >> pedro.duquevie...@gmail.com> wrote: >> >> >> >>> I would remove the window decorations. That's platform dependent, >> windows, >> >>> linux, mac have different aesthetics for this. They also don't add any >> >>> value to the representation of the control. >> >>> >> >>> That's what I usually do. >> >>> >> >>> Cheers, >> >>> >> >>> >> >>> >> >>> >> >>> -- >> >>> Pedro Duque Vieira - https://www.pixelduke.com >> >>> >> >>
Re: JDK-8210361: Add images to docs for public API classes of controls
Hi Nir, Thanks for this RFE. Now other UI toolkits like GTK and QT have a separate gallery of controls[1][2]. I was considering to add something similar in JavaFX but I never got around to start working on it, mostly due to all the screenshots which is needed to be taken beforehand ! Since you will now take images of all the controls, you can consider to add a gallery in this RFE itself. But if you don't want then someone else (me) can volunteer to do this once this RFE is merged. Let me know what you decide :-) [1] : https://developer.gnome.org/gtk4/stable/ch03.html [2] : http://doc.qt.io/archives/qt-4.8/gallery.html On Thu 13 Sep, 2018, 12:07 AM Kevin Rushforth, wrote: > Agreed. For simple controls like checkbox, button, etc., it makes sense > to use an undecorated Stage. It's less busy and puts the emphasis on the > control being illustrated. > > -- Kevin > > > On 9/12/2018 7:57 AM, Pedro Duque Vieira wrote: > > Yes I agree with you. Controls on which their window decorations are a > part > > of them, should show up with them. If those decorations change depending > on > > the platform their running, I would put a note saying that. > > > > The vast majority of controls don't belong to that category. > > > > Cheers, > > > > On Wed, Sep 12, 2018 at 3:51 PM Nir Lisker wrote: > > > >> That's sensible, though for Alert and the like I think they should stay > as > >> it's effectively part of the control. > >> > >> On Wed, Sep 12, 2018 at 4:19 PM Pedro Duque Vieira < > >> pedro.duquevie...@gmail.com> wrote: > >> > >>> I would remove the window decorations. That's platform dependent, > windows, > >>> linux, mac have different aesthetics for this. They also don't add any > >>> value to the representation of the control. > >>> > >>> That's what I usually do. > >>> > >>> Cheers, > >>> > >>> > >>> > >>> > >>> -- > >>> Pedro Duque Vieira - https://www.pixelduke.com > >>> > >
Re: JDK-8210361: Add images to docs for public API classes of controls
Agreed. For simple controls like checkbox, button, etc., it makes sense to use an undecorated Stage. It's less busy and puts the emphasis on the control being illustrated. -- Kevin On 9/12/2018 7:57 AM, Pedro Duque Vieira wrote: Yes I agree with you. Controls on which their window decorations are a part of them, should show up with them. If those decorations change depending on the platform their running, I would put a note saying that. The vast majority of controls don't belong to that category. Cheers, On Wed, Sep 12, 2018 at 3:51 PM Nir Lisker wrote: That's sensible, though for Alert and the like I think they should stay as it's effectively part of the control. On Wed, Sep 12, 2018 at 4:19 PM Pedro Duque Vieira < pedro.duquevie...@gmail.com> wrote: I would remove the window decorations. That's platform dependent, windows, linux, mac have different aesthetics for this. They also don't add any value to the representation of the control. That's what I usually do. Cheers, -- Pedro Duque Vieira - https://www.pixelduke.com
Re: JDK-8210361: Add images to docs for public API classes of controls
Yes I agree with you. Controls on which their window decorations are a part of them, should show up with them. If those decorations change depending on the platform their running, I would put a note saying that. The vast majority of controls don't belong to that category. Cheers, On Wed, Sep 12, 2018 at 3:51 PM Nir Lisker wrote: > That's sensible, though for Alert and the like I think they should stay as > it's effectively part of the control. > > On Wed, Sep 12, 2018 at 4:19 PM Pedro Duque Vieira < > pedro.duquevie...@gmail.com> wrote: > >> I would remove the window decorations. That's platform dependent, windows, >> linux, mac have different aesthetics for this. They also don't add any >> value to the representation of the control. >> >> That's what I usually do. >> >> Cheers, >> >> >> >> >> -- >> Pedro Duque Vieira - https://www.pixelduke.com >> > -- Pedro Duque Vieira - https://www.pixelduke.com
Re: JDK-8210361: Add images to docs for public API classes of controls
That's sensible, though for Alert and the like I think they should stay as it's effectively part of the control. On Wed, Sep 12, 2018 at 4:19 PM Pedro Duque Vieira < pedro.duquevie...@gmail.com> wrote: > I would remove the window decorations. That's platform dependent, windows, > linux, mac have different aesthetics for this. They also don't add any > value to the representation of the control. > > That's what I usually do. > > Cheers, > > > > > -- > Pedro Duque Vieira - https://www.pixelduke.com >
Re: JDK-8210361: Add images to docs for public API classes of controls
I would remove the window decorations. That's platform dependent, windows, linux, mac have different aesthetics for this. They also don't add any value to the representation of the control. That's what I usually do. Cheers, -- Pedro Duque Vieira - https://www.pixelduke.com
Re: JDK-8210361: Add images to docs for public API classes of controls
They look fine to me. I think placing them next to the code sample, near the bottom, seems best. -- Kevin On 9/12/2018 1:42 AM, Nir Lisker wrote: Hi, Iv'e started working on JDK-8210361 [1] and I'd like my comment there addressed before continuing. [1] https://bugs.openjdk.java.net/browse/JDK-8210361 Thanks, Nir
JDK-8210361: Add images to docs for public API classes of controls
Hi, Iv'e started working on JDK-8210361 [1] and I'd like my comment there addressed before continuing. [1] https://bugs.openjdk.java.net/browse/JDK-8210361 Thanks, Nir