swingx
  1. swingx
  2. SWINGX-102

JXCollapsiblePane javadoc needs more detail

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: 0.9.0
    • Fix Version/s: 0.9.0
    • Labels:
      None
    • Environment:

      Operating System: All
      Platform: Macintosh

    • Issuezilla Id:
      102

      Description

      The javadoc for JXCollapsiblePane is quite thin. Before 1.0 it needs the
      following basic improvements:

      1) A more detailed description which includes a simple example of how to
      create one.

      2) A little more detail on methods; in particular on the "animated" and "collapsed"
      properties

        Activity

        Hide
        l2fprod added a comment -

        will work on it

        Show
        l2fprod added a comment - will work on it
        Hide
        l2fprod added a comment -

        assigned to me

        Show
        l2fprod added a comment - assigned to me
        Hide
        l2fprod added a comment -

        updated javadoc of JXCollapsiblePane, comments welcome

        Show
        l2fprod added a comment - updated javadoc of JXCollapsiblePane, comments welcome
        Hide
        rbair added a comment -

        Fred

        The getContentPane method states:

        " Sets the content pane of this JXCollapsiblePane. Components must be added
        to this content pane, not to the JXCollapsiblePane."

        But then we have overridden addImpl and the remove methods.

        Can we either change the doc, or remove the contentPane methods entirely (hide
        the fact we use a content pane)?

        The rest of the documentation looks excellent. After addressing these issues, we
        should be able to close this issue.

        Show
        rbair added a comment - Fred The getContentPane method states: " Sets the content pane of this JXCollapsiblePane. Components must be added to this content pane, not to the JXCollapsiblePane." But then we have overridden addImpl and the remove methods. Can we either change the doc, or remove the contentPane methods entirely (hide the fact we use a content pane)? The rest of the documentation looks excellent. After addressing these issues, we should be able to close this issue.
        Hide
        l2fprod added a comment -

        I'll just remove the statement "components must be added..."

        Don't want to just remove the contentPane methods as one may use its own contentPane implementation
        rather than the one provided by the JXCollapsiblePane.

        Show
        l2fprod added a comment - I'll just remove the statement "components must be added..." Don't want to just remove the contentPane methods as one may use its own contentPane implementation rather than the one provided by the JXCollapsiblePane.
        Hide
        l2fprod added a comment -

        unless someone wants more doc...

        Show
        l2fprod added a comment - unless someone wants more doc...

          People

          • Assignee:
            l2fprod
            Reporter:
            aim
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: