You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pivot.apache.org by "Steven Swor (JIRA)" <ji...@apache.org> on 2012/12/03 23:35:59 UTC

[jira] [Created] (PIVOT-883) Update Javadoc for ComponentStateListener method arguments

Steven Swor created PIVOT-883:
---------------------------------

             Summary: Update Javadoc for ComponentStateListener method arguments
                 Key: PIVOT-883
                 URL: https://issues.apache.org/jira/browse/PIVOT-883
             Project: Pivot
          Issue Type: Improvement
          Components: wtk
    Affects Versions: 2.0.2, 2.0.1, 2.0
            Reporter: Steven Swor
            Priority: Minor
             Fix For: 2.0.3


The org.apache.pivot.wtk.ComponentStateListener interface has two methods, enabledChanged(Component) and focusedChanged(Component, Component).

While it should be pretty intuitive that the single argument of enabledChanged is the component whose enabled state has changed, the javadoc for the focusedChanged method is a bit vague as to what each argument represents.  I'm assuming that the "component" argument is the one which lost focus and "obverseComponent" is the one that gained focus, but I could have that backwards :-)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Assigned] (PIVOT-883) Update Javadoc for ComponentStateListener method arguments

Posted by "Roger Whitcomb (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/PIVOT-883?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Roger Whitcomb reassigned PIVOT-883:
------------------------------------

    Assignee: Roger Whitcomb
    
> Update Javadoc for ComponentStateListener method arguments
> ----------------------------------------------------------
>
>                 Key: PIVOT-883
>                 URL: https://issues.apache.org/jira/browse/PIVOT-883
>             Project: Pivot
>          Issue Type: Improvement
>          Components: wtk
>    Affects Versions: 2.0, 2.0.1, 2.0.2
>            Reporter: Steven Swor
>            Assignee: Roger Whitcomb
>            Priority: Minor
>              Labels: documentation,, javadoc
>             Fix For: 2.0.3
>
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> The org.apache.pivot.wtk.ComponentStateListener interface has two methods, enabledChanged(Component) and focusedChanged(Component, Component).
> While it should be pretty intuitive that the single argument of enabledChanged is the component whose enabled state has changed, the javadoc for the focusedChanged method is a bit vague as to what each argument represents.  I'm assuming that the "component" argument is the one which lost focus and "obverseComponent" is the one that gained focus, but I could have that backwards :-)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Resolved] (PIVOT-883) Update Javadoc for ComponentStateListener method arguments

Posted by "Roger Whitcomb (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/PIVOT-883?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Roger Whitcomb resolved PIVOT-883.
----------------------------------

    Resolution: Fixed

Added more explanation of both methods (including the parameters) of the ComponentStateListener interface.

[trunk]
Sending        wtk\src\org\apache\pivot\wtk\ComponentStateListener.java
Transmitting file data .
Committed revision 1417081.

[branches/2.0.x]
Sending        .
Sending        wtk\src\org\apache\pivot\wtk\ComponentStateListener.java
Transmitting file data .
Committed revision 1417088.
                
> Update Javadoc for ComponentStateListener method arguments
> ----------------------------------------------------------
>
>                 Key: PIVOT-883
>                 URL: https://issues.apache.org/jira/browse/PIVOT-883
>             Project: Pivot
>          Issue Type: Improvement
>          Components: wtk
>    Affects Versions: 2.0, 2.0.1, 2.0.2
>            Reporter: Steven Swor
>            Assignee: Roger Whitcomb
>            Priority: Minor
>              Labels: documentation,, javadoc
>             Fix For: 2.0.3
>
>   Original Estimate: 1m
>  Remaining Estimate: 1m
>
> The org.apache.pivot.wtk.ComponentStateListener interface has two methods, enabledChanged(Component) and focusedChanged(Component, Component).
> While it should be pretty intuitive that the single argument of enabledChanged is the component whose enabled state has changed, the javadoc for the focusedChanged method is a bit vague as to what each argument represents.  I'm assuming that the "component" argument is the one which lost focus and "obverseComponent" is the one that gained focus, but I could have that backwards :-)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira