home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2005 June / PCpro_2005_06.ISO / files / opensource / xamp / xampp-win32.exe / xampp / progress.setborderpainted.cls < prev    next >
Encoding:
Text File  |  2004-03-24  |  2.8 KB  |  103 lines
  1. <refentry id="{@id}">
  2.  <refnamediv>
  3.   <refname>setBorderPainted Manual</refname>
  4.   <refpurpose>determines whether the progress bar should paint its border</refpurpose>
  5.  </refnamediv>
  6.  <refsynopsisdiv>
  7.   <refsynopsisdivinfo>
  8.    <author>
  9.     by Laurent Laville
  10.     <authorblurb>{@link mailto:pear@laurent-laville.org}</authorblurb>
  11.    </author>
  12.    <copyright>November 2003, Laurent Laville</copyright>
  13.    <releaseinfo>HTML_Progress 1.0+</releaseinfo>
  14.   </refsynopsisdivinfo>
  15.  </refsynopsisdiv>
  16.  <refsect1 id="{@id synopsis}">
  17.   <title>Synopsis</title>
  18.   <para><emphasis>void</emphasis> <important>setBorderPainted</important>( $paint )</para>
  19.  </refsect1>
  20.  <refsect1 id="{@id attributes}">
  21.   <title>Attributes</title>
  22.   <para>
  23.    <table frame="all">
  24.     <tgroup cols="3">
  25.     <thead align="center">
  26.       <row>
  27.        <entry><important>Name</important></entry>
  28.        <entry><important>Type</important></entry>
  29.        <entry><important>Default</important></entry>
  30.       </row>
  31.     </thead>
  32.     <tbody>
  33.      <row>
  34.       <entry><emphasis>paint</emphasis> </entry>
  35.       <entry>boolean                    </entry>
  36.       <entry>false | [ true ]           </entry>
  37.      </row>
  38.     </tbody>
  39.     </tgroup>
  40.    </table>
  41.   </para>
  42.  </refsect1>
  43.  <refsect1 id="{@id description}">
  44.   <title>Description</title>
  45.   <para>The <emphasis>setBorderPainted()</emphasis> method is used to decide whether 
  46.    the progress bar should paint its border or not. The default value is false: 
  47.    progress bar without border.
  48.   </para>
  49.  </refsect1>
  50.  <refsect1 id="{@id example}">
  51.   <title>Example</title>
  52.   <para>
  53.    Example below will produced a progress bar with a solid red border. It's a static example, 
  54.    the progress bar will not run.
  55.    <para><graphic fileref="../media/screenshots/border1.png"></graphic></para>
  56.    <programlisting role="php">
  57.    <![CDATA[
  58. <?php
  59. require_once ('HTML/Progress.php');
  60.  
  61. $bar = new HTML_Progress();
  62. $bar->setBorderPainted(true);
  63.  
  64. $ui =& $bar->getUI();
  65. $ui->setBorderAttributes(array(
  66.         'width' => 2,
  67.         'style' => 'solid',
  68.         'color' => 'red'
  69.         ));
  70.  
  71. ?>
  72. <!DOCTYPE html
  73.     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  74.     "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  75.  
  76. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  77. <head>
  78. <title>ProgressBar </title>
  79. <style type="text/css">
  80. <!--
  81. <?php echo $bar->getStyle(); ?>
  82. // -->
  83. </style>
  84. <body>
  85.  
  86. <?php echo $bar->toHtml(); ?>
  87.  
  88. </body>
  89. </html>
  90.    ]]>
  91.    </programlisting>
  92.   </para>
  93.  </refsect1>
  94.  <refsect1 id="{@id seealso}">
  95.   <title>See Also</title>
  96.   <para>
  97.    Take care that <emphasis>setBorderPainted()</emphasis> method is not enough to display
  98.    a border. You should also defines border attributes. To do it see
  99.    {@tutorial ui.setborderattributes.cls}.
  100.   </para>
  101.  </refsect1>
  102. </refentry>
  103.