ProgressMonitor Class Documentation

classProgressMonitor

Namespace:com::datalogics::PDFL

Detailed Description

Represents the progress of an operation. The class can display a dialog if a process will take time, and the Progress method can indicate how long the process will last.

Referenced by

DocumentPDFOptimizerSignDoc

Constructor & Destructor Documentation

ProgressMonitor

ProgressMonitor()

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

beginOperation

voidbeginOperation()

Returns:

void

Initializes the progress monitor and displays it with a current value of zero. This method will be called first when the progress monitor is used.

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

endOperation

voidendOperation()

Returns:

void

Draws the progress monitor with its current value set to the progress monitor's duration (a full progress monitor), then removes the progress monitor from the display.

finalize

voidfinalize()

Returns:

void

getCurrentValue

intgetCurrentValue()

Returns:

int

The current value of the progress monitor. The allowed value ranges from 0 (empty) to the value passed to SetDuration.

For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.

getDuration

intgetDuration()

Returns:

int

The progress monitor's duration.

setCurrentValue

voidsetCurrentValue(intcurrentValue)

Parameters

currentValue: int

The progress monitor's current value.

Returns:

void

Sets the current value of the progress monitor and updates the display. The allowed value ranges from 0 (empty) to the value passed to SetDuration.

For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.

setDuration

voidsetDuration(intduration)

Parameters

duration: int

The maximum value the progress monitor will be allowed to have.

Returns:

void

Sets the value that corresponds to a full progress monitor display. The progress monitor is subsequently filled in by setting its current value. This method will be called before setting the progress monitor's current value.

setText

voidsetText(Stringtext)

Parameters

text: String

Returns:

void

Display a UTF-8 text string in the progress monitor.