Class ConsoleDebug

This class is instantiated during the initialization of the Plug-in event manager and the ID is assigned to the variable '%_ConsoleDebug'. It provides methods to simplify the debugging of new logic within the framework used by the plug-in.

Build Information

Author Fred McGuirk
Date Dec 4, 2006
Outputfile ConsoleDebug.pvc
Forcelinenumbers false

Constructor

Initialize the object, store the object references passed in, and create a reference to the [ProvideX Class:PvxConstants].

ParameterDescription
initEventManager A reference to the [Java Class:eventmanager/EventManager] object
initViewManager A reference to the [Java Class:views/UIManager] object

Properties

PROPERTY _version$

Methods

FUNCTION breakpoint()

Break into console mode. This method will also hide any active progress monitor [ProvideX Class:ProgressMonitor].

This method invocation does not affect any pending events for the Java event manager [Java Class:eventmanager/EventManager].
FUNCTION breakpoint(ClearEvent)

Break into console mode. This method will also hide any active progress monitor [ProvideX Class:ProgressMonitor].

ParameterDescription
ClearEvent ** Optional ** A simple boolean (0=false, 1=true) to force a clear of any pending events for the Java event manager [Java Class:eventmanager/EventManager].
FUNCTION close_trace()

Close the trace file.

FUNCTION end_trace()

Stop the program trace. The trace file is NOT closed.

FUNCTION open_trace(to_file$)

Create (if necessary) and open a text file to be used to log information while debugging a class or extension.

ParameterDescription
to_file$ The name of a text file to create/open for logging of trace information.
FUNCTION resume()

Restore the progress monitor if it was active and resume execution of the application.

FUNCTION start_trace()

Start a program trace to the trace file that must have already been openned.

FUNCTION write_trace(inText$)

Write a text message to the trace file.

ParameterDescription
inText$ A string containing the text to be written to the trace file.