ePages 6.11.0 - DE_EPAGES/Presentation/API/Object/ProgressMonitor.pm

Package DE_EPAGES::Presentation::API::Object::ProgressMonitor

This module implements a progress monitor that displays a HTML page showing the state and progress of a lenghy operation, such as import/export.
Used by DE_EPAGES::Presentation::API::CSV::MonitoredExportDriver, DE_EPAGES::Presentation::API::CSV::MonitoredImportHandler and DE_EPAGES::Presentation::API::XML::MonitoredExportDriver.

Base
DE_EPAGES::Core::API::Object::ProgressMonitor
Example
use DE_EPAGES::Presentation::API::Object::ProgressMonitor;

my $Monitor = DE_EPAGES::Presentation::API::Object::ProgressMonitor->new(
    'PageTypeName' => 'FroogleMonitor',
    'Object'       => $self->object,
    'Total'        => 30,
    'Current'      => 0,
);

for my $i (1 ..30) {
    sleep 1;
    $Monitor->incCurrent;
    $Monitor->write;
}

Functions

new

new

Starts the progress monitor for servlet requests.

Syntax
$ProgressMonitor = __PACKAGE__->new(%options);
Input
%options (hash)
following keys are used :
  • Servlet - current servlet (optional)
  • Object - view object -object
  • PageTypeName - name of page type - string
  • RefreshInterval - refresh intervall (optional, default 2 sec.) - integer
Return
$ProgressMonitor (object)
monitor