[UserStory] QT4BJ extension has its own panel in BlueJ Preferences>Extensions #112 #146
Conversation
AcceptanceTest.md
Outdated
| @@ -0,0 +1,23 @@ | |||
| # AcceptanceTest for QualityToolsExtension.jar | |||
There was a problem hiding this comment.
Is there exactly one and only one acceptance test? Is a new file needed for an additional test?
Is the intent that this only apply to a file named QualityToolsExtension.jar? Does it need to be rewritten or replaced if the name of the jar file evolves during the lifetime of the product?
AcceptanceTest.md
Outdated
| @@ -0,0 +1,23 @@ | |||
| # AcceptanceTest for QualityToolsExtension.jar | |||
|
|
|||
| Due to the difficulty of JUnit tests developers created the following acceptance test to verify the start up functionality of the BlueJ application. | |||
There was a problem hiding this comment.
What is meant by "Due to the difficulty of JUnit tests"? What is the intent of the opening phrase of this document?
There was a problem hiding this comment.
Invoking the BlueJ proxy object to create a JUnit test.
AcceptanceTest.md
Outdated
|
|
||
| # Steps | ||
|
|
||
| 1) Gradle build the project with JDK version 11 |
There was a problem hiding this comment.
As I progress through this document, I begin to understand that this is intended more as a "one off" acceptance criterion than something useful for longer duration of product development and maintenance.
If this is the case, then it should appear as "Acceptance Criteria" in the associated issue, rather than as a document in the repository.
Consider copying the verification steps to the appropriate issue(s) and deleting this document.
There was a problem hiding this comment.
After discussing with the group, having a JTextField displayed in the quality tools extension tab serves no purpose. The intent was to match the #112 user story "picture display"
| class Preferences implements PreferenceGenerator | ||
| { | ||
| private JPanel myPanel; | ||
| private JTextField color; |
There was a problem hiding this comment.
What is the intent of this field? It seems irrelevant.
There was a problem hiding this comment.
Field is needed to create JTextField from the Swing API.
After discussing with the group, having a JTextField displayed in the quality tools extension tab serves no purpose. The intent was to match the #112 user story "picture display"
new commit will remove field
There was a problem hiding this comment.
The intent was to match the #112 user story "picture display"
Matching that with something relevant to the product, such as, "Quality Analysis Tools", would have been fine. "color" just seems irrelevant.
| */ | ||
| class Preferences implements PreferenceGenerator | ||
| { | ||
| private JPanel myPanel; |
There was a problem hiding this comment.
All fields and methods should be commented, using Javadoc-style comments.
| @@ -91,3 +99,42 @@ public URL getURL() { | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * Create a Preference Panel located in the BlueJ application | |||
There was a problem hiding this comment.
This comment seems to indicate that this class determines the location of the panel. That doesn't seem to be the actual way this is working.
| myPanel = new JPanel(); | ||
| myPanel.add (new JLabel ("Quality Analysis Tools")); | ||
| color = new JTextField (40); | ||
| myPanel.add (color); |
There was a problem hiding this comment.
We will remove "color" object as it was used to store the JTextField. There is no user input required for this user story. Will remove lines of code associated with "color".
For reference and to answer your question see the information below.
color = new JTextField (40);
API recommends Note:
"We encourage you to specify the number of columns for each text field. If you do not specify the number of columns or a preferred size, then the field's preferred size changes whenever the text changes, which can result in unwanted layout updates."
https://docs.oracle.com/javase/tutorial/uiswing/components/textfield.html
There was a problem hiding this comment.
Just a note that it is less about "user input" and more about the choice of "color" in particular as having no obvious relevance and likely being an unintended artifact of a copy-paste of work done by others.
| myPanel.add (new JLabel ("Quality Analysis Tools")); | ||
| color = new JTextField (40); | ||
| myPanel.add (color); | ||
| // Load the default value |
There was a problem hiding this comment.
What is meant by "default value"?
jody
added
enhancement
Deleted AcceptanceTest.md. Content of AcceptanceTest.md was better suited inside user story MetroCS#112
Added Javadoc-style comments, deleted example JPanel.
|
New commits will reflect BlueJ application under BlueJ->Preferences->Extensions Tab
|
There was a problem hiding this comment.
This code doesn't appear to follow the coding convention guidelines for the project.
See: Coding Convention Guide
Method headers, class headers, authors
Created Preferences class and associated acceptance test as an AcceptanceTest.md.