Skip to main content

Any how-tos available?

21 replies [Last post]
Anonymous

Since we've been talking about how-tos the last few days, are there
any written yet? I can (maybe) help out, wondering about format,
length, focus, etc.

Also, any ideas about if we should link to component JavaDoc from the
how-tos, and how to manage that? If we do, we need to have JavaDoc
uploaded, versioned, and in a relative directory somewhere.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Kleopatra

Patrick Wright wrote:
> I checked in the update to SwingXDemo and the table demo with the new
> description. It ends with a Read More link, but I have no
> listener--need to figure where/how we want to display the contents.
>

how about "Eating our own food" - using a JXHyperlink as a
rightDecorator in the title of the information panel? Maybe with an icon
only ... hmm, do we have an appropriate "speaking" icon?

Anyway, I'll give it a try - we can throw it out again if it doesn't
look/work correctly

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

For right now, I updated the names of the demos, and added a Read More
at the end of the text. It brings up the HowToWindow, a separate
frame. The content is uberhaupt hässlich :D as we're using the
JEditorPane and it can't render java.net wrappers.

We might need to bypass and stuff the how-tos in resources.html, seems
it would be easiest to control the content. I don't know how we can
pull this off java.net and display otherwise.

Alternately, if we tag our own content in the how-to with a #anchor
for start and end, we could parse and pull just the content and
display that, but that seems dumb.

Feel free to try the icon on the title, sounds good.

Hmm.
Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:
>
> Feel free to try the icon on the title, sounds good.
>

okay, did it: it's not an icon, the position is not okay, the window
opened looks ugly as hell, and and and... but it seems to work (curtesy
of a custom EditorPaneLinkVisitor which opens a frame for itself if
necessary)

obviously it's competing with the HowToWindow - we'll need to take the
best of both approaches, I think, but now I need a rest ;-)

CU
Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

Wait! I can't open SwingXDemo anymore in NB4.1--did you make the
changes manually in code, or using NB? Which version of NB?

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:
> Wait! I can't open SwingXDemo anymore in NB4.1--did you make the
> changes manually in code, or using NB? Which version of NB?

ehh... only outside of the generated blocks ...

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Kleopatra wrote:
> Patrick Wright wrote:
>
>>Wait! I can't open SwingXDemo anymore in NB4.1--did you make the
>>changes manually in code, or using NB? Which version of NB?
>
>
> ehh... only outside of the generated blocks ...
>

okay, just checked the differences between 1.30 (the last I committed)
and 1.29 (your last). As far as I there are only differences similar to
those which didn't hurt in the past. No clue what happened ... sorry:-(
Revert is nothing else helps.

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

Hi Jeanette

Thanks for the fix. I can now build and open stuff.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Morning Patrick

>
> Thanks for the fix. I can now build and open stuff.
>
>

scratching my head... actually I _didn't_ do anything after my last
commit (1.30). Some weird magic one way or the other

BTW, did you hear anything from Amy during the night? The code in cvs
looks unchanged

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

Morning Jeanette

Another beautiful day in Berlin! Lucky us!

> BTW, did you hear anything from Amy during the night? The code in cvs
> looks unchanged

No, I didn't hear anything either. Hmm. Maybe will assume she will
work on descriptions for individual demos. I'll see if I can hack
around on how-tos.

Still not sure the best way to display how-tos, or where to pull them
from. Still think we either try to launch the default browser
(probably using JDIC) or pull from the resources.html package. Ideas?

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:
> Morning Jeanette
>
> Another beautiful day in Berlin! Lucky us!
>

yeah, indeed - will be hard to keep focused on the work instead of
sipping a long drink in the sun

>
> No, I didn't hear anything either. Hmm. Maybe will assume she will
> work on descriptions for individual demos. I'll see if I can hack
> around on how-tos.

sounds reasonable.

>
> Still not sure the best way to display how-tos, or where to pull them
> from. Still think we either try to launch the default browser
> (probably using JDIC) or pull from the resources.html package. Ideas?

no ideas - not sure if you should pull in yet another dependency, but if
you feel like it, go ahead.

BTW, I just committed a SwingXDemo version with a factored url creation,
so we have one point to change when changing the howto source (probably
should go one step further and let getHowtoUrlString only return the
actual filename specific for the current demo and a getHowToBase() which
is common to all demos) Hope nothing's broken.

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:

(sorry for being so sluggish in responding - was neck-deep in
unsuccessfully debugging those f*** sorters ... I start to really hate
them :-(

> I added a SwingXDemo to swingx_dev, with a new description for the
> JXTableDemo. I rewrote the description in two paragraphs--the first
> introducing the features available, and the second describing the
> demo. The demo's name is in the information title bar, not in the
> text.
>

good - I like your changes (BTW - I think you can change directly in
swingx instead of swingx_dev)

> I'd remove the gradient on the description pane. Right now that's
> being assigned in the NB initComponents() block, but I can't find the
> corresponding assignment in design view. Anyway, the gradient makes
> the text hard to read.

I agree, Richard loves gradients - but this one is way too dark To
get rid off without disturbing the initComps (did I ever mentioned that
I hate those generated code blocks?) we can add a
descriptionPane.setOpaque(true) at the end of the constructor.

>
> I'm aiming for brevity--I think the demo itself should really be
> front-and-center, and no scrolling should be necessary on the details
> pane. Whatever the layout, the SplitPane should be adjusted for some
> particular resolution, e.g. we test with a given resolution and set of
> descriptions, then set a reasonable height for the split; currently a
> number of the descriptions scroll...
>

okay - this will "naturally" give the length of the text. Your table
demo description nearly fits into a 1024* resolution. If there is
scrolling in the editorpane, the caret should be at the start of the
text. To get it, call descriptionPane.setCaretPosition(0) after loading
the text.

uploaded the swingxDemo without gradient and with the caret at first
position.

> What about the how-tos? Seems the easiest thing to do (well,
> relatively) would be to have a button or read-more hyperlink, which
> then opens a browser window to the SwingX demos site for the
> respective how-to. The how-tos can then be updated without repackaging
> the demo.
>

sounds good.

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

chicuslavic
Offline
Joined: 2005-02-26
Points: 0

I'd like to work on complete master-detail example with SQL database

Slavic

Patrick Wright

Slavic

Sounds good--FYI there was some discussion last fall about what DB
engine to use for demos, and which database. The consensus then was to
use Hypersonic SQL (open source, fits in a jar), and a database that
ships with Hibernate, called CaveatEmptor. I think hypersonic is
already downloaded into some of the JDNC subprojects. CE is a good
example as well, as there are also mapped Java classes using
Hibernate, which is good for later showing counter-examples of using
Hibernate and the databinding/JavaBeans stuff.

You don't have to use these, of course, but just to let you know what
we talked about.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Hi Patrick,

> Since we've been talking about how-tos the last few days, are there
> any written yet? I can (maybe) help out, wondering about format,
> length, focus, etc.

what a generous offer - unfortunately I'm way behind on even starting to
think about how-tos :-(

Currently I'm wondering about how much/which info to put into the "Info"
region of the demos - my extremes are hyperlink demo on the one end and
table demo at the other: while the former contains lots of technical
info I rewrote the latter to contain information about what to do with
the demo only (similar to the info text in the decorator demo).

Right now I am leaning (unstable) to the latter as content for the info
leaving the more technical issues for the how-tos.

Opinions?

BTW: whatever the decision - any volunteers to cleanup the info texts of
the demos? Mine are probably full of errors, the others are in different
states of completeness, and we still didn't decide about general visual
style (bold, headers, ...) guidelines

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

Hey Jeanette

Just took a look at the newest info descriptions in the demo.

> Currently I'm wondering about how much/which info to put into the "Info"
> region of the demos - my extremes are hyperlink demo on the one end and
> table demo at the other: while the former contains lots of technical
> info I rewrote the latter to contain information about what to do with
> the demo only (similar to the info text in the decorator demo).
>
> Right now I am leaning (unstable) to the latter as content for the info
> leaving the more technical issues for the how-tos.

I agree that technical issues should be in the how-tos. Definitely
should cover using the demo in the description, but maybe up to two
sentences to note the features of the displayed control, e.g.
"With the new table and tree controls your users can select which
columns to show via a column selection menu, rearrange columns via
drag and drop, highlight rows with pluggable background highlighters,
sort their data via clickable headers and more.

In this demo, try moving columns right or left by dragging them
around. To select which columns to display, click on the column
selector in the top right corner. Change background color highlighting
using the combobox and radio buttons at the bottom. Note the you can
also re-size table columns automatically from the column selection
window, as well as apply horizontal scrolling.

(link)"

As far as formatting, I don't like the headings--the bold, black,
large text stands out too much against the more subtle titles in the
titled panels. My thought is maybe to put the title of the current
demo in the title, as "Information - Hyperlink Demo", and have the
text just kick off with a description.

I'm not especially a design guy, but I know what I like. My thoughts are:
- the demo serves to whet the appetite of the user, so the description
should serve that purpose as well. it should just introduce the
components briefly and describe typical use.

- avoid boldface if possible

- keep it short; the details should be in the how-to. from my
recollection, SwingSet was pretty self-explanatory; of course, those
were pretty standard GUI controls.

> Opinions?
>
> BTW: whatever the decision - any volunteers to cleanup the info texts of
> the demos? Mine are probably full of errors, the others are in different
> states of completeness, and we still didn't decide about general visual
> style (bold, headers, ...) guidelines

I can do this if we can come up with a decent template (both for style
and content to base it on). Maybe just use this thread to hammer out
one good description for one demo (content), then update that demo
text and play with the styling.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

I added a SwingXDemo to swingx_dev, with a new description for the
JXTableDemo. I rewrote the description in two paragraphs--the first
introducing the features available, and the second describing the
demo. The demo's name is in the information title bar, not in the
text.

I'd remove the gradient on the description pane. Right now that's
being assigned in the NB initComponents() block, but I can't find the
corresponding assignment in design view. Anyway, the gradient makes
the text hard to read.

I'm aiming for brevity--I think the demo itself should really be
front-and-center, and no scrolling should be necessary on the details
pane. Whatever the layout, the SplitPane should be adjusted for some
particular resolution, e.g. we test with a given resolution and set of
descriptions, then set a reasonable height for the split; currently a
number of the descriptions scroll...

What about the how-tos? Seems the easiest thing to do (well,
relatively) would be to have a button or read-more hyperlink, which
then opens a browser window to the SwingX demos site for the
respective how-to. The how-tos can then be updated without repackaging
the demo.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

I just posted a Wiki page as a proposal for how we might structure how-tos.

http://wiki.java.net/bin/preview/Javadesktop/JDNCJXTableHowTo

Writing on the Wiki should be faster (because of the easier syntax)
than using HTML. We can then scrape and dump in the SwingX-demos
www/documentation directory.

Comments? The basic idea is to list the major features of the
component right at the top, then break down the descriptions by
functionality offered. Each section can then have code samples, small
screenshots, etc.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:
> I just posted a Wiki page as a proposal for how we might structure how-tos.
>
> http://wiki.java.net/bin/preview/Javadesktop/JDNCJXTableHowTo
>
> Writing on the Wiki should be faster (because of the easier syntax)
> than using HTML. We can then scrape and dump in the SwingX-demos
> www/documentation directory.
>
> Comments? The basic idea is to list the major features of the
> component right at the top, then break down the descriptions by
> functionality offered. Each section can then have code samples, small
> screenshots, etc.
>

Looks good - now we need an auto-fill function

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

I checked in the update to SwingXDemo and the table demo with the new
description. It ends with a Read More link, but I have no
listener--need to figure where/how we want to display the contents.

I think for right now, just to be able to see the HowTos, I'll pop
open a separate window with an EditorPane and pull the HowTo in by
URL, currently from the Wiki. We can replace with a call to open the
default browser.

I'll start working on the other descriptions next.
Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Patrick Wright

Oh, I'm assuming we'll lay things out for 1024 x 768. Complaints,
please chirp in. Should we maximize the Window by default?
Descriptions will never show properly otherwise.

Also, changes are directly in the demo.swingx package, not _dev.

Patrick

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net

Kleopatra

Patrick Wright wrote:
> Oh, I'm assuming we'll lay things out for 1024 x 768. Complaints,
> please chirp in.

okay.
> Should we maximize the Window by default?
> Descriptions will never show properly otherwise.

hm, leave it to the user?

>
> Also, changes are directly in the demo.swingx package, not _dev.
>

good. I just added a getInformtionTitle to the demoPanel and made
SwingXDemo use it.

BTW, there's a related thread.. just saw that you found it

Jeanette

---------------------------------------------------------------------
To unsubscribe, e-mail: jdnc-unsubscribe@jdnc.dev.java.net
For additional commands, e-mail: jdnc-help@jdnc.dev.java.net