EWS::dictDocument - object-oriented perl module to extend functionality of EWS::htmlout.
use EWS::dictDocument;
$html = new EWS::dictDocument(-debug => 0,
-title => 'My page',
-application => 'myapp',
-version => '0.1.2');
$html->SendPageHeader;
...
EWS::dictDocument provides additional methods to read the form data returned from the browser-agent and several output and page formatting utility methods.
EWS::dictDocument extends the EWS::htmlout class and is itself extensible.
This is version 1.0 of EWS::dictDocument.
$html = new EWS::dictDocument(%parameters);
or
$html = EWS::dictDocument->new(%parameters);
Enter:
%parameters = parameter hash (see below).
Exit:
returns a blessed reference to a new dictDocument object.
parameters are of the form:
-arg => value
acceptable values are:
-application => second line of page name
-author => author's name
-debug => 1 = debug messages
-file => name of file to trace to (refer to EWS::baseIO).
-style => reference to array of style sheet names (path)
-title => default page name
-type => type of tracing (refer to EWS::baseIO).
-version => page version number
Display head and title sections
Enter:
%parameters = parameter hash (see below).
Exit:
none.
parameters are of the form:
-arg => value
acceptable values are:
-author = name of HTML document author.
-title = HTML document title.
-application = second line of page name
-version = current version
Enter:
%parameters = parameter hash (see below).
Exit:
none.
parameters are of the form:
-arg => value
acceptable values are:
-title = first line of title.
-application = second line (beneath page title).
-version = current version
-alert = (optional) pop-up alert to send with page.
Send HTML document start code and a page title
Enter:
%parameters = parameter hash (see below).
Exit:
none.
parameters are of the form:
-arg => value
acceptable values are:
-title = first line of title.
-application = second line (beneath page title).
-version = current version
-alert = (optional) pop-up alert to send with page.
Send document start sequence.
Enter:
%parameters = parameter hash (see below).
Exit:
none.
parameters are of the form:
-arg => value
acceptable values are:
-alert = (optional) pop-up alert to send with page.
-application = second line (beneath page title).
-author = author's name
-onload = onLoad text
-style = style sheet
-title = first line of title.
-version = current version
Send HTML document end code
Enter:
none.
Exit:
none.
Outputs the HTML blank token.
Enter:
none.
Exit:
none.
Display error message and end document (exit).
Entry:
$message = message to output
Exit:
none.
Display error message. Error is sent as an alert.
Entry:
$ErrorMessage = error message
Exit:
none.
Display the error message displayed as a pop-up alert, if document output hasn't started, as a BOLD message in the document if it has.
Entry:
$ErrorMessage = error message to display
Exit:
none.
Read-Write.
Enter:
$application = second line of page header.
Exit:
$application = current page header.
if $application is not defined on input, it will not be modified.
Set/get author.
Enter:
$author = name of page author
Exit:
$author = current author name
Read-Only.
Enter:
none.
Exit:
$endneeded = current value.
Read-Write.
Enter:
$title = first line of title.
Exit:
$title = current title.
if $title is not defined on input, it will not be modified.
Read-Write.
Enter:
$version = version string.
Exit:
$version = current version string.
if $version is not defined on input, it will not be modified.
The Revision method returns the revision number of dictDocument.pm:
Read-Only.
Enter:
none.
Exit:
current revision string.
Read-Only.
Enter:
none.
Exit:
$startneeded = current value.
Read-Write.
Enter:
$stylesheet = stylesheet array reference.
Exit:
$stylesheet = stylesheet array reference.
if $stylesheet is not defined on input, it will not be modified.
The Version method returns the version number of dictDocument.pm
Read-Only.
Enter:
none.
Exit:
current version string.
Display parameters passed to method (debug only).
Enter:
$methodname = name of method calling this method.
%parameters = parameter list passed to method
Exit:
none.
EWS::dictDocument is dependent upon the following support modules:
EWS::htmlout is the base class from which EWS::dictDocument is derived. It is an object-oriented class which provides HTML 4.0 methods.
EWS::dictDocument is available at
Jay Wheeler, EarthWalk Software.
EWS::dictDocument is copyright © 2002. EarthWalk Software.
This module is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This module is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA