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

Class: HTML_Progress_DM

Source Location: /Progress/DM.php

Class Overview


The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values.


Author(s):

Version:

  • 1.2.0

Methods



Class Details

[line 32]
The HTML_Progress_DM class handles any mathematical issues arising from assigning faulty values.



Tags:

license:  PHP License 3.0
access:  public
author:  Laurent Laville <pear@laurent-laville.org>
version:  1.2.0


[ Top ]


Class Methods


constructor HTML_Progress_DM [line 108]

HTML_Progress_DM HTML_Progress_DM( )

The data model class constructor

Constructor Summary

  • Creates a progress mathematical model with a minimum value set to 0, a maximum value set to 100, and a increment value set to +1. By default, the value is initialized to be equal to the minimum value.
    1. $html = new HTML_Progress_DM();
  • Creates a progress mathematical model with minimum and maximum set to specified values, and a increment value set to +1. By default, the value is initialized to be equal to the minimum value.
    1. $html = new HTML_Progress_DM($min, $max);
  • Creates a progress mathematical model with minimum, maximum and increment set to specified values. By default, the value is initialized to be equal to the minimum value.
    1. $html = new HTML_Progress_DM($min, $max, $inc);




Tags:

throws:  HTML_PROGRESS_ERROR_INVALID_INPUT
access:  public
since:  1.0


[ Top ]

method getIncrement [line 352]

integer getIncrement( )

Returns the progress bar's increment value. The default value is +1.



Tags:

tutorial:  HTML_Progress::getIncrement
see:  HTML_Progress_DM::setIncrement()
access:  public
since:  1.0


[ Top ]

method getMaximum [line 295]

integer getMaximum( )

Returns the progress bar's maximum value. The default value is 100.



Tags:

tutorial:  HTML_Progress::getMaximum
see:  HTML_Progress_DM::setMaximum()
access:  public
since:  1.0


[ Top ]

method getMinimum [line 238]

integer getMinimum( )

Returns the progress bar's minimum value. The default value is 0.



Tags:

tutorial:  HTML_Progress::getMinimum
see:  HTML_Progress_DM::setMinimum()
access:  public
since:  1.0


[ Top ]

method getPercentComplete [line 470]

float getPercentComplete( )

Returns the percent complete for the progress bar. Note that this number is between 0.00 and 1.00.



Tags:



[ Top ]

method getValue [line 399]

integer getValue( )

Returns the progress bar's current value. The value is always between the minimum and maximum values, inclusive.

By default, the value is initialized with the minimum value.




Tags:

tutorial:  HTML_Progress::getValue
see:  HTML_Progress_DM::setValue()
access:  public
since:  1.0


[ Top ]

method incValue [line 453]

void incValue( )

Updates the progress bar's current value by adding increment value.



Tags:

tutorial:  HTML_Progress::incValue
see:  HTML_Progress_DM::getValue(), HTML_Progress_DM::setValue()
access:  public
since:  1.0


[ Top ]

method setIncrement [line 369]

void setIncrement( integer $inc)

Sets the progress bar's increment value.



Tags:

tutorial:  HTML_Progress::setIncrement
see:  HTML_Progress_DM::getIncrement()
throws:  HTML_PROGRESS_ERROR_INVALID_INPUT
access:  public
since:  1.0


Parameters:

integer   $inc   progress bar's increment value

[ Top ]

method setMaximum [line 312]

void setMaximum( integer $max)

Sets the progress bar's maximum value.



Tags:

tutorial:  HTML_Progress::setMaximum
see:  HTML_Progress_DM::getMaximum()
throws:  HTML_PROGRESS_ERROR_INVALID_INPUT
access:  public
since:  1.0


Parameters:

integer   $max   progress bar's maximal value

[ Top ]

method setMinimum [line 255]

void setMinimum( integer $min)

Sets the progress bar's minimum value.



Tags:

tutorial:  HTML_Progress::setMinimum
see:  HTML_Progress_DM::getMinimum()
throws:  HTML_PROGRESS_ERROR_INVALID_INPUT
access:  public
since:  1.0


Parameters:

integer   $min   progress bar's minimal value

[ Top ]

method setValue [line 418]

void setValue( integer $val)

Sets the progress bar's current value.

If the new value is different from previous value, all change listeners are notified.




Tags:

tutorial:  HTML_Progress::setValue
see:  HTML_Progress_DM::getValue()
throws:  HTML_PROGRESS_ERROR_INVALID_INPUT
access:  public
since:  1.0


Parameters:

integer   $val   progress bar's current value

[ Top ]


Documentation generated on Sun, 12 Sep 2004 20:23:40 +0200 by phpDocumentor 1.3.0RC3