RichTextFX icon indicating copy to clipboard operation
RichTextFX copied to clipboard

Update demos jar to be an Application that browses all demos like ControlsFX's samples.jar

Open JordanMartinez opened this issue 8 years ago • 3 comments

Coming from #413, it was proposed that we repackage all demos in one JAR file and follow the approach used by ControlsFX. In that case, the jar would be called samples-[version].jar.

I'm opening this issue as a way to discuss this further.

JordanMartinez avatar Jan 19 '17 20:01 JordanMartinez

The demos are already packaged in one jar, namely richtextfx-demos. I understand that what is being proposed is to create an application in which one can browse all the available demos.

TomasMikula avatar Jan 19 '17 21:01 TomasMikula

The demos are already packaged in one jar, namely richtextfx-demos. I understand that what is being proposed is to create an application in which one can browse all the available demos.

Mm, thanks for the correction. I'll update the issue name to better reflect that.

JordanMartinez avatar Jan 19 '17 21:01 JordanMartinez

I spent some time implementing this today and have some feedback about it now.

On the upside, this allows one to quickly browse through all the applications at once, making it that much more convenient. Once implemented, the ReadMe could be updated to list only one command one needs to run to start the sampler, though what's currently there probably shouldn't be deleted as it contains commands for older versions.

On the down side, ControlsFX's FXSampler seems to be designed for a single simple component. This comes with a few issues we'll need to work around:

  • Demos with multiple pieces (i.e. the less complex LineIndicatorDemo and the more complex RichTextDemo) cannot show all of their source code in the Source tab. One could put all of the code into a single file, but that gets very confusing for RichTextDemo.
  • Demos often demonstrate a particular area feature, not the area itself. So, the CSS tab and Javadoc tab are somewhat irrelevant.

We could file an issue for some of these features. However, I don't think they'd make such changes since their current design works well in demonstrating the controls they make and these changes might make such things more difficult.

We could fork their work and modify it to better suit our needs, but that entails starting another project.

JordanMartinez avatar Jun 27 '17 05:06 JordanMartinez