STAGE 2.0 USER MANUAL

Overview

ChangeStyle is a style formatter extension for the BlueJ Java IDE. Oftentimes a programmer has difficulty conforming to different style rules at the expense of development time. ChangeStyle provides a way for any programmer working with BlueJ to convert their code to any coding style in seconds, thus increasing efficiency. This extension reduces the time spent manually reformatting code. ChangeStyle formats code depending on the options the user specifies. It formats the specified file on demand by using the Style Conventions, that can be modified. Some key features include setting the format settings to preset Style Conventions such as K&R Style and Sun Style, formatting braces, whitespace, and indentation. For more features look in 5.0 Features.

1.0 Requirements

The following requirements should be met to ensure proper working conditions:

• J2SE 1.6.0 (Java 2 SDK version 1.6.0) or newer must be installed.

• BlueJ 2.2 or newer must be installed

• Must Run: Minimum: 64Mb main memory, Pentium II processor or equivalent Recommended: 128Mb main memory, 400MHz Pentium III processor or above

2.0 Installation

Extensions are installed by placing the extension jar file into an extension directory. BlueJ has three separate locations for extensions, each giving the extension a different scope. The locations are:

Verify Extension Installed

To verify extension installed go to Help > Installed Extensions.

Click on the ? to find more information about ChangeStyle .

If ChangeStyle is not there, for more information go to.

[BlueJ Extension Installation Help]

3.0 Usage

3.1 Format the Code

3.1.1 Format one Class.

Start BlueJ. Open a project. Optionally open editor.

Right click the Class of choice. Click on ChangeStyle > Format to format the selected class using the current style conventions.(If editor window is open the changes will be immediately visible. Otherwise you must open the editor to see the changes.)

The editor window, if open shows the 'formatted' code.

3.1.2 Format All Files

Start BlueJ. Open a project. Optionally open editor.

Click on Tools > ChangeStyle > Format Entire Project to format all the classes in the current package using the current style conventions.(If editor window is open for any class, the changes will be immediately visible for that class. Otherwise you must open the editor to see the changes.)

The editor window, if open shows the 'formatted' code.

When not all of the classes in the package are compiled an error window will pop-up and ChangeStyle will not format the classes.

3.2 Undo Formatting

NOTE: Only works immediately after formatting code (the code cannot be altered since the last format).

3.2.1 Undo Class

Right click on the class and click on ChangeStyle > Undo.

The original code appears in the editor window.

3.2.2 Multiple File Undo

Click on Tools > ChangeStyle > Undo Formatting.

A window will open that ask what files the user wants to undo. Check the checkbox of the files to undo and click Undo

4.0 Edit Style Conventions

To edit the Style Conventions used to format your code or to Export / Import those Style Conventions the ChangeStyle Editor is used. To access the Editor go to Tools > Preferences.

In the window that pops up go to the Extensions tab and if necessary scroll down to the ChangeStyle section.

4.1 Import and Export Conventions

4.1.1 Edit

Edit lets you change the current conventions.

The name of the convention will be called Custom... until it has been exported or saved. The user may also edit saved conventions.

The Settings Dialog panel is opened so that the Style Convention Configuration Files can be edited and customized.

4.1.2 Import

Import lets the user import a predefined convention from any where in their directory.

It opens a browser window for the user to locate the file.

4.1.3 Save

Save will save the convention to ChangeStyle's directory for storing conventions

Type in the Convention Name that it will be saved under. Click Ok

4.1.4 Export

Export will open a browse that will let the user save the conventions any where they may want.

4.1.5 Remove

Remove will remove the Style Convention that is currently showing. It will not remove the predefined conventions.

For a more in depth explanation of K & R look at [The C Programming Language, Second Edition]

4.2.3 Sun Convention

[Sun Convention Rules]

4.2.4 Dalbey Style

Dalbey Style is Sun Conventions with five different rules.

• Open-close braces are aligned vertically

• One character varaibles are not allowed

• No ternary expressions

• There are no Beginning Comments

• In an if-else statement the if and else should be vertically aligned.

[More detailed Dalbey Style Rules]

4.3 Printer

The most important part of the Custom Settings is the Printer section. Here is where the specific Style Rules are defined. As each Style Rule is defined, the window to the right shows the original and formatted sample source code.

Click Ok or Apply if you want to approve this Convention and move on or Cancel to exit the Editor without saving these changes.

4.3.1 Header and Footer

[Jalopy Manual]

5. 0 Specific Style Conventions

The objective of ChangeStyle is to properly format code to a specified format.ChangeStyle provides many features which can be specified by the user.

ChangeStyle allows the formatting preferences to be specified by the graphical interface.

ChangeStyle checks and formats the following style:

[Brace]

[White Space]

[Indentation]

[Wrapping]

[Blank Lines]

[Comments]

[Import]

[Environment]

[Fix Javadoc headings]

[Header]

[Footer]

[Sorting]

[Additional features]

6.0 Credits