PEAR Progress2 logo

HTML_Progress2 : The Definitive Guide

HTML_Progress2 Manual
     Next

HTML_Progress2 Manual

First Edition

Edited by

Laurent Laville

Copyright © 2005, 2006, 2007, 2008 Laurent Laville

This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit http://creativecommons.org/licenses/.

Revision History
Revision 2.4.0 April 20, 2007
  • Finally after one more release, include as promised the HOWTO_AJAX.txt file content to this guide.
  • Change FAQ Howto entries, especially on Upload and AJAX solutions
Revision 2.3.0 Juin 13, 2007
  • License changed from PHP 3.01 to New BSD
  • Fixed Doc Bug #10879 : add a warning annotation on Progress Monitor usage (about example line 43, see chapter 6)
  • Manual license Creative Commons upgrade from version 2.0 to 3.0
Revision 2.2.0 January 2, 2007
  • Add new feature to import an existing stylesheet to separate PHP code form HTML layout (with CSS). See migration guide, new features chapter for details.
  • Copyright bumped to 2007
  • New section for 2.2.x revisons in chapter : What is new in version 2?
Revision 2.1.1 December 21, 2006
  • PHP sources code are now all highlighted to improve readability
  • Fixed path on hide() method page reference for function synopsis info (missing HTML/)
  • Added "alt" html-tag attribute on all images/screenshots to be more xhtml compliant.
Revision 2.1.0 August 12, 2006
  • FAQ is now up-to-date with the latest informations. See especially the common freeze progress bar problem.
  • What's new chapter splitted by minor version (2.0, 2.1) with their details.
  • Finally a quick start guide to use HTML_Progress2_Generator.
  • New examples with comment in Appendixes section.
Revision 2.0.1 May 24, 2006
  • TDG revision number follow the package release version.
  • Fixes closing html - style tag of examples in Appendixes.
  • Fixes typo error in chapter 5 (thanks to Stefan Valouch).
Revision 1.0.0 September 23, 2005
  • The final (stable) first edition of this Guide.

Table of Contents

Preface
Organization of This Book
Pre-requisites
I. Introduction
1. About Progress2
2. What's New in version 2 ?
3. FAQ - Frequently Asked Questions
II. Getting Started
4. Introduction
5. Quick Start with HTML_Progress2
6. Indeterminate Mode
7. Listener
8. Quick Start with HTML_Progress2_Monitor
9. Quick Start with HTML_Progress2_Generator
10. How to to implement an AJAX Progress Bar
11. How to to implement an AJAX Upload with Progress Bar solution
III. Migrating Guide
12. Introduction
13. How to adjust your code
14. New Features in HTML_Progress2
IV. Reference Guide
15. Introduction
16. Error Handler
17. Events to observe
18. HTML_Progress2_Lite
19. API - Application Programming Interface
V. Appendixes
20. HTML_Progress2 and HTML_Progress2_Lite features comparative
21. Examples

List of Figures

21.1. Basic usage with default skin
21.2. Indeterminate Mode usage
21.3. Multi Labels usage
21.4. Progress as a listener to Event_Dispatcher
21.5. Monitoring usage
21.6. Progress Generator wizard usage

List of Tables

14.1. Error Handling major changes
16.1. Error Handler configuration parameters
16.2. Display driver configuration parameters
16.3. Log driver configuration parameters
18.1. HTML_Progress2_Lite : position and size attributes
18.2. HTML_Progress2_Lite : color attributes
18.3. HTML_Progress2_Lite : frame attributes
18.4. HTML_Progress2_Lite : TEXT label attributes
18.5. HTML_Progress2_Lite : BUTTON label attributes
18.6. HTML_Progress2_Lite : STEP label attributes
18.7. HTML_Progress2_Lite : PERCENT label attributes
18.8. HTML_Progress2_Lite : CROSSBAR label attributes
20.1. HTML_Progress2_Lite features comparative

List of Examples

14.1. script: examples/horizontal/ancestor.php
14.2. script: progress2BasicHandler.js
14.3. ancestor.css
14.4. New content of ancestor.css
14.5. ancestor.css with two skins
21.1. Without any customization
21.2. progress bar in indeterminate mode
21.3. Four kind of progress label
21.4. Progress bar listen to user process
21.5. progress bar into a quickform window
21.6. Progress Generator build with PEAR::HTML_Page2
HTML_Progress2 : The Definitive Guide v 2.4.0 : April 20, 2007
     Next
     Preface