HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Prev Next

Reference Guides

will help you if you don't remember how to use API

by Laurent Laville
mailto:pear@laurent-laville.org
March 2004, Laurent Laville
(HTML_Progress 1.2)

Table of Contents

Classes Overview

General methods

These common methods allow to manage UI and DM classes component, change internal progress bar identifier, and display html output or properties structure.

  • HTML_Progress::display()
  • HTML_Progress::toHtml()
  • HTML_Progress::toArray()
  • HTML_Progress::getUI()
  • HTML_Progress::setUI()
  • HTML_Progress::getDM()
  • HTML_Progress::setDM()
  • HTML_Progress::getIdent()
  • HTML_Progress::setIdent()
  • HTML_Progress::getAnimSpeed()
  • HTML_Progress::setAnimSpeed()

  • Mathematical methods

    Default mathematical model (HTML_Progress_DM class) handles a common progress bar with a minimum and initial value sets to 0, a maximum set to 100, and an increment set to 1.

  • HTML_Progress::getIncrement()
  • HTML_Progress::setIncrement()
  • HTML_Progress::getMaximum()
  • HTML_Progress::setMaximum()
  • HTML_Progress::getMinimum()
  • HTML_Progress::setMinimum()
  • HTML_Progress::getValue()
  • HTML_Progress::setValue()
  • HTML_Progress::incValue()
  • HTML_Progress::getPercentComplete()

  • Graphical methods

    Default progress bar is a horizontal ten cells bar with no border and standard percent info string, and runs in determinate mode.

  • HTML_Progress::getString()
  • HTML_Progress::setString()
  • HTML_Progress::isStringPainted()
  • HTML_Progress::setStringPainted()
  • HTML_Progress::isBorderPainted()
  • HTML_Progress::setBorderPainted()
  • HTML_Progress::getScript()
  • HTML_Progress::getStyle()
  • HTML_Progress::setModel()
  • HTML_Progress::isIndeterminate()
  • HTML_Progress::setIndeterminate()

  • Listeners methods

    HTML_Progress_Observer class provide an implementation of the observer pattern. In the content of the HTML_Progress package, it provide a mechanism by which you can examine special event as it is happened. This allows the implementation of special behavior.

  • HTML_Progress::addListener()
  • HTML_Progress::removeListener()
  • HTML_Progress::getListeners()

  • Data Model

    The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values. You can overload it with HTML_Progress::setDM() method.

  • HTML_Progress_DM::getIncrement()
  • HTML_Progress_DM::setIncrement()
  • HTML_Progress_DM::getMaximum()
  • HTML_Progress_DM::setMaximum()
  • HTML_Progress_DM::getMinimum()
  • HTML_Progress_DM::setMinimum()
  • HTML_Progress_DM::getValue()
  • HTML_Progress_DM::setValue()
  • HTML_Progress_DM::incValue()
  • HTML_Progress_DM::getPercentComplete()

  • User Interface

    The HTML_Progress_UI class provides methods for html code display and element attributes handling.

  • HTML_Progress_UI::getProgressAttributes()
  • HTML_Progress_UI::setProgressAttributes()
  • HTML_Progress_UI::getStringAttributes()
  • HTML_Progress_UI::setStringAttributes()
  • HTML_Progress_UI::getBorderAttributes()
  • HTML_Progress_UI::setBorderAttributes()
  • HTML_Progress_UI::getCellAttributes()
  • HTML_Progress_UI::setCellAttributes()
  • HTML_Progress_UI::getCellCoordinates()
  • HTML_Progress_UI::setCellCoordinates()
  • HTML_Progress_UI::getCellCount()
  • HTML_Progress_UI::setCellCount()
  • HTML_Progress_UI::getFillWay()
  • HTML_Progress_UI::setFillWay()
  • HTML_Progress_UI::getOrientation()
  • HTML_Progress_UI::setOrientation()
  • HTML_Progress_UI::getScript()
  • HTML_Progress_UI::setScript()
  • HTML_Progress_UI::getStyle()

  • Prev Up Next
    Getting Started HTML_Progress 1.x Guide getIdent Manual

    Documentation generated on Mon, 11 Mar 2019 13:52:34 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.