HTML_Progress
[ class tree: HTML_Progress ] [ index: HTML_Progress ] [ all elements ]
Prev Next
HTML_Progress_UI::setCellCoordinates
sets the coordinates of each cell for a polygonal shape

Synopsis

require_once 'HTML/Progress/UI.php';

mixed HTML_Progress_UI::setCellCoordinates( int $xgrid int $ygrid array $coord = NULL)

Description

This method is used to define all cell coordinates of any progress meter polygonal shape (square, rectangle ...)

Parameter

    integer $xgrid
  • the grid width in cell size.

    integer $ygrid
  • the grid height in cell size.

    array $coord
  • the coordinates (x,y) in the grid, of each cell.

Throws

Possible PEAR_Error values

Error level Error code Error message Solution
exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$xgrid" was expecting "integer" Fixed the cast of parameter
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$xgrid" was expecting "greater than 2" Give an integer greater than two
exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #2 "$ygrid" was expecting "integer" Fixed the cast of parameter
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #2 "$ygrid" was expecting "greater than 2" Give an integer greater than two
exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #3 "$coord" was expecting "array" Fixed the cast of parameter
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #3 "$coord" was expecting "coordinate less than grid width" Fixed the cell x-coordinate or the parameter #1 (grid width)
error HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #3 "$coord" was expecting "coordinate less than grid height" Fixed the cell y-coordinate or the parameter #2 (grid height)

Note

( HTML_Progress >= 1.2.0RC1 )

This function can not be called statically.

For basic shapes (square, rectangle), you don't have to give all cell coordinates. HTML_Progress will compute it for you. You should have to give the cell coordinates list only for free polygonal shape.

See

HTML_Progress_UI::getCellCoordinates

Example

Example below will create a rectangle 6x4 (see line 18).

  1. <?php
  2. require_once 'HTML/Progress.php';
  3.  
  4. $bar = new HTML_Progress();
  5. $bar->setAnimSpeed(250);
  6. $bar->setIncrement(10);
  7.  
  8. $ui =& $bar->getUI();
  9. $ui->setStringAttributes('valign=bottom align=center width=90 height=30');
  10. $ui->setOrientation(HTML_PROGRESS_POLYGONAL);
  11. $ui->setCellAttributes(array(
  12. 'width' => 15,
  13. 'height' => 15,
  14. 'active-color' => 'red',
  15. 'inactive-color' => 'orange',
  16. )
  17. );
  18. $ui->setCellCoordinates(6,4); // Rectangle 6x4
  19. ?>
  20. <html>
  21. <head>
  22. <title>setCellCoordinates example</title>
  23. <style type="text/css">
  24. <!--
  25. <?php echo $bar->getStyle(); ?>
  26. // -->
  27. </style>
  28. <script type="text/javascript">
  29. <!--
  30. <?php echo $ui->getScript(); ?>
  31. //-->
  32. </script>
  33. </head>
  34. <body>
  35.  
  36. <?php
  37. echo $bar->toHtml();
  38. $bar->run();
  39. ?>
  40.  
  41. </body>
  42. </html>

Prev Up Next
HTML_Progress_UI::getCellCoordinates Reference Guide HTML_Progress_UI::getBorderAttributes

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