How Site Reports Work; How Stand-Alone Reports Work - MACROMEDIA DREAMWEAVER MX 2004-EXTENDING DREAMWEAVER Manual

How site reports work

Reports are accessible through the Site > Reports... menu. When it is selected, this menu item
1
displays a dialog box from which the user selects reports to run on a choice of targets.
The user selects which files to run the selected reports on using the Report On: pop-up menu.
2
This menu contains Current Document, Entire Current Local Site, Selected Files In Site, and
Folder. When the user selects the Folder option, a Browse button and text field appear, so the
user can select a folder.
The user can customize reports that have parameters by selecting the Settings button and
3
entering values for the parameters. Each report must include a Settings dialog box, if a user
needs to set report parameters. This dialog box is optional; not every report requires the user to
set the report's parameters. If a report does not have a Settings dialog box, then the Report
Settings... button is dimmed when the report is selected in the list.
After the reports are selected and their settings are set, the user clicks the Run button.
4
At this point, Dreamweaver clears all items from the Site Reports tab of the Results panel.
Dreamweaver calls the
process begins. If a report returns a
report run.
Each file is passed to each report that was selected in the Reports dialog box using the
5
processFile()
list, it should call the
process continues until all files that pertain to the user's selection are processed or the user clicks
the Stop button in the bottom of the window. Dreamweaver displays the name of each file being
processed and the number of files that remain to be processed.
Dreamweaver calls the
processed and the reporting process completes.

How stand-alone reports work

The custom command opens a new results window by calling the
1
function and storing the returned results object in a window variable. The remaining functions
in this process should be called as methods of this object.
The custom command initializes the title and format of the Results window by calling the
2
setTitle()
The command can either start adding items to the Results window immediately by calling the
3
function, or it can begin iterating through a list of files by calling the
addItem()
setFileList()
When the command calls
4
processFile()
the stand-alone command. It receives the file URL as its only argument. Use the
setCallbackCommands()
call the
processFile()
To call the
5
addItem() function
Results window that was created by the stand-alone command. The
can also call the
the list of files.
198 Chapter 10: Reports
beginReporting()
function. If the report needs to include information about this file in the results
dw.resultsPalette.siteReports.addResultItem()
endReporting()
and
SetColumnWidths()
and
startProcessing()
resWin.startProcessing()
function for each file URL in the list. Define the
function of the Results window object if you want Dreamweaver to
function in some other command.
, the
stopProcessing()
function in each report before the reporting
value from this function, it is removed from the
false
function in each report after all the files have been
functions as methods of the Results window object.
functions as methods of the Results window object.
, Dreamweaver calls the
function needs to have access to the
processFile()
function of the Results window object to stop processing
function. This
dw.createResultsWindow()
function in
processFile()
function
processFile()