Generating an outline

Warning - java2web is now obsolete. Please use its successor: code2web

back to index

Java2Web can generate an outline box containing all (top-level) declarations found in the source code, ordered first by identifier type (fields first, methods next, etc...) and alphabetically. The contents of the box is clickable, so clicking on a method or fields takes the user to the place of the source code where it is declared.

By default the outline box is off, but you can enable it using the generateOutline property.

HTMLConverter   boolean getGenerateOutline()
void setGenerateOutline( boolean onoff)
Java2Web   java2web ... --generateOutline = true | false...
<j2w:convert>   <j2w:convert ... generateOutline="true|false" ... >

The generated outline box looks like this:

Example of an outline box

The style of the outline box is controlled by the outlineStyle property, which has a default value of "outline"

HTMLConverter   String getOutlineStyle()
void setOutlineStyle( String style )
Java2Web   java2web ... --outlineStyle = xxxxx ...
<j2w:convert>   <j2w:convert ... outlineStyle="style" ... >

Also, the outline box uses a number of images (a standard set of Eclipse-like icons are included in the distribution). The names of the images are not configurable, but the location where they are placed is controlled by the imageLocation property, which has a default value of "icons/".

HTMLConverter   String getImageLocation()
void setImageLocation( String location)
Java2Web   java2web ... --imageLocation = xxxxx ...
<j2w:convert>   <j2w:convert ... imageLocation="location" ... >