Using the J report window

Important information on using the J report window!

All the methods used to handle J report windows are stored in the default#Report profile. This means that every time you call a method, you must prefix the name of the method with #Report#.

Creating a report window

JNoModalBox Object:createReportBox (in String title)

This method creates a J report window, and destroys the former J report window, if this already exists.

This method does not display the newly-created J report window. To display it, you should "manually" call the following standard method on the J report window:

show (in boolean objecteeringInConsultMode)

Example:

JNoModalBox box = #Report#createReportBox

( "My report box") ;

JNoModalBox Object:createNewReportBox (in String title)

This creates a new J report window, even if one already exists.

This method does not display the newly-created J report window. To display it, you should "manually" call the following standard method on the J report window:

show (in boolean objecteeringInConsultMode)

JNoModalBox Object:createReportBoxWithIdent

(in String title,

in String pIdentifier);

This creates a new J report window whose identifier is used in the "pIdentifier" parameter. If a J report window with this identifier already exists, it is destroyed.

This method does not display the newly-created J report window. To display it, you should "manually" call the following standard method on the J report window:

show (in boolean objecteeringInConsultMode)

Creating and displaying a report window

JNoModalBox Object:createAndShowReportBox (in String title)

This method creates a J report window, destroys the former J report window (if this already exists), and displays the newly-created J report window.

JNoModalBox Object:createAndShowNewReportBox (in String title)

This creates a new J report window, even if one already exists, and displays it.

JNoModalBox Object:createAndShowReportBoxWithIdent

(in String title,

in String pIdentifier);

This creates and displays a new J report window whose identifier is used in the "pIdentifier" parameter. If a J report window with this identifier already exists, it is destroyed.

Adding report lines

Each method below enables the developer to add lines to a J report window. These methods all use the following parameters:

· String type: This gives a string determining which icon should be used for the report line. This can be the path to a bitmap or one of the predefined strings shown in the table below:

The ... type	has the ... bitmap
info
warning
error
modif
add
delete
zoom
debug

· String title: This indicates the title of the report line.

· Object link: This specifies a browsable object to which the report line is linked. When the user double-clicks on the report line in question, the linked object will be selected in the explorer.

Adding a report line at the root

JTreeItem Object:linkToReport ( in string type ,

in string title )

This adds a report line to the root of the report window and links it to the current (this) object.

Example:

#Report#linkToReport("info", "Information on

'"+Name+"'.") ;

JTreeItem JTree:addReport ( in string type ,

in string title ,

in Object link )

This adds a report line to the root of the report window and links it to the link object.

Example:

JTreeItem aReportItem = box.#Report#addReport

("warning" ,

"A warning" ,

this);

Adding a report line under another report line

JTreeItem Object:linkToReportUnder

(in string parentTitle ,

in string type ,

in string title )

This adds a report line to the J report box and links it to the current object. The new report line is added under the "parentTitle" access path line. Each access path line should be separated by a "/".

Example:

To insert a new report line under the "B" report line, which itself is under the "A" report line, proceed as follows: