Source for file CornersStyleCollection.class.php

Documentation is available at CornersStyleCollection.class.php

  1. <?php
    2. 

  2.  
    3. 

  3. require_once(HARMONI."GUIManager/StyleCollection.interface.php");
    4. 

  4.  
    5. 

  5. /**
    6. 

  6.  * A StyleCollection is one of the tree building pieces of CSS styles. As the  name
    7. 

  7.  * suggests it handles a collection of StyleProperties.
    8. 

  8.  * 
    9. 

  9.  * The other two CSS styles building pieces are <code>StylePropertiy</code> and
    10. 

  10.  * <code>StyleComponent</code>. To clarify the relationship between these three
    11. 

  11.  * building pieces, consider the following example:
    12. 

  12.  * <pre>
    13. 

  13.  * div {
    14. 

  14.  *     margin: 20px;
    15. 

  15.  *     border: 1px solid #000;
    16. 

  16.  * }
    17. 

  17.  * </pre>
    18. 

  18.  * <code>div</code> is a <code>StyleCollection</code> consisting of 2
    19. 

  19.  * <code>StyleProperties</code>: <code>margin</code> and <code>border</code>. Each
    20. 

  20.  * of the latter consists of one or more <code>StyleComponents</code>. In
    21. 

  21.  * specific, <code>margin</code> consists of one <code>StyleComponent</code>
    22. 

  22.  * with the value <code>20px</code>, and <code>border</code> has three
    23. 

  23.  * <code>StyleComponents</code> with values <code>1px</code>, <code>solid</code>,
    24. 

  24.  * and <code>#000</code> correspondingly.
    25. 

  25.  *
    26. 

  26.  * @package harmoni.gui
    27. 

  27.  * 
    28. 

  28.  * @copyright Copyright &copy; 2005, Middlebury College
    29. 

  29.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
    30. 

  30.  *
    31. 

  31.  * @version $Id: CornersStyleCollection.class.php,v 1.3 2005/12/12 16:06:14 adamfranco Exp $
    32. 

  32.  */
    33. 

  33. class CornersStyleCollection 
    34. 

  34.     extends StyleCollection 
    35. 

  35. {
    36. 

  36.     
    37. 

  37.     /**
    38. 

  38.      * @var array $_urls; 
    39. 

  39.      * @access private
    40. 

  40.      * @since 11/28/05
    41. 

  41.      */
    42. 

  42.     var $_urls;
    43. 

  43.     
    44. 

  44.     /**
    45. 

  45.      * @var array $_positions; 
    46. 

  46.      * @access private
    47. 

  47.      * @since 11/28/05
    48. 

  48.      */
    49. 

  49.     var $_positions;
    50. 

  50.     
    51. 

  51.     /**
    52. 

  52.      * The constructor.
    53. 

  53.      * @access public
    54. 

  54.      * @param string selector The selector of this StyleCollection.
    55. 

  55.      * @param string classSelector The class selector of this style collection. If <code>null</code>,
    56. 

  56.      *  it will be ignored, but the collection will not be able to be applied
    57. 

  57.      *  to components.
    58. 

  58.      * @param string displayName The display name of this StyleCollection.
    59. 

  59.      * @param string description The description of this StyleCollection.
    60. 

  60.      ***/
    61. 

  61.     function CornersStyleCollection($selector, $classSelector, $displayName, $description) {
    62. 

  62.         $this->StyleCollection($selector, $classSelector, $displayName, $description);
    63. 

  63.         $this->_positions = array("TopLeft", "TopRight", "BottomLeft", "BottomRight");
    64. 

  64.         $this->_urls = array();
    65. 

  65.     }
    66. 

  66.     
    67. 

  67.     /**
    68. 

  68.      * Set the url of the corner image
    69. 

  69.      * 
    70. 

  70.      * @param string $position 
    71. 

  71.      * @param string $url 
    72. 

  72.      * @param optional int $height
    73. 

  73.      * @param optional int $width
    74. 

  74.      * @return void 
    75. 

  75.      * @access public
    76. 

  76.      * @since 11/28/05
    77. 

  77.      */
    78. 

  78.     function setBorderUrl ($position, $url, $height = 15, $width = 15) {
    79. 

  79.         if (!in_array($position, $this->_positions))
    80. 

  80.             throwError(new Error("Invalid Position, $position"));
    81. 

  81.         
    82. 

  82.         $this->_urls[$position] = $url;
    83. 

  83.         $this->_heights[$position] = $height;
    84. 

  84.         $this->_widths[$position] = $width;
    85. 

  85.         
    86. 

  86.     }
    87. 

  87.     
    88. 

  88.     /**
    89. 

  89.      * Set the url of the corner image
    90. 

  90.      * 
    91. 

  91.      * @param string $position 
    92. 

  92.      * @return void 
    93. 

  93.      * @access public
    94. 

  94.      * @since 11/28/05
    95. 

  95.      */
    96. 

  96.     function getBorderUrl ($position) {
    97. 

  97.         if (!in_array($position, $this->_positions))
    98. 

  98.             throwError(new Error("Invalid Position, $position"));
    99. 

  99.         
    100. 

  100.         return $this->_urls[$position];
    101. 

  101.     }
    102. 

  102.  
    103. 

  103.     /**
    104. 

  104.      * Returns the CSS code for this StyleCollection.
    105. 

  105.      * @access public
    106. 

  106.      * @param string tabs This is a string (normally a bunch of tabs) that will be
    107. 

  107.      *  prepended to each text line. This argument is optional but its usage is highly
    108. 

  108.      *  recommended in order to produce a nicely formatted HTML output.
    109. 

  109.      * @return string The CSS code for this StyleCollection.
    110. 

  110.      ***/
    111. 

  111.     function getCSS($tabs = "") {
    112. 

  112.         // nothing to return
    113. 

  113.         if (count($this->_SPs) == 0) 
    114. 

  114.             return "";
    115. 

  115.  
    116. 

  116.         $wrapperValues = array();
    117. 

  117.         $contentValues = array();
    118. 

  118.         $wrapperKeys = array("display", "visibility", "position", "margin", "height", "width");
    119. 

  119.         foreach (array_keys($this->_SPs) as $key) {
    120. 

  120.             if (!in_array($key, $wrapperKeys))
    121. 

  121.                 $contentValues[] = $this->_SPs[$key]->getCSS();
    122. 

  122.             else {
    123. 

  123.                 if (strstr("margin", $key)) {
    124. 

  124.                     $wrapperValues[] = str_replace("margin", "padding", $this->_SPs[$key]->getCSS());
    125. 

  125.                 } else {
    126. 

  126.                     $wrapperValues[] = $this->_SPs[$key]->getCSS();
    127. 

  127.                 }
    128. 

  128.             }
    129. 

  129.         }
    130. 

  130.         
    131. 

  131.         $css = $tabs.$this->_selector." {\n\t".$tabs;
    132. 

  132.         $css .= implode("\n\t".$tabs, $wrapperValues);
    133. 

  133.         $css .= "\n".$tabs."\tborder: 0px;\n";
    134. 

  134.         $css .= $tabs."}\n";
    135. 

  135.             
    136. 

  136.         $css .= $tabs.$this->_selector."Content {\n\t".$tabs;
    137. 

  137.         $css .= implode("\n\t".$tabs, $contentValues);
    138. 

  138.         $css .= "\n".$tabs."\tmargin: 0px;\n";
    139. 

  139.         $css .= $tabs."}\n";
    140. 

  140.         
    141. 

  141.         
    142. 

  142.         $css .= $tabs.".".$this->_classSelector."TopCorners, ."
    143. 

  143.             .$this->_classSelector."BottomCorners {\n";
    144. 

  144.         $css .= $tabs."\tmargin: 0px;\n";
    145. 

  145.         $css .= $tabs."\tpadding: 0px;\n";
    146. 

  146.         $css .= $tabs."}\n";
    147. 

  147.         
    148. 

  148.         
    149. 

  149.         
    150. 

  150.         $css .= $tabs.".".$this->_classSelector."Spacer {\n";
    151. 

  151.         $css .= $tabs."\tmargin: 0px; padding: 0px; border: 0px;\n";
    152. 

  152.         $css .= $tabs."\tclear: both;\n";
    153. 

  153.         $css .= $tabs."\tfont-size: 1px; line-height: 1px;\n";
    154. 

  154.         $css .= $tabs."}\n";
    155. 

  155.         
    156. 

  156.         $css .= "
    157. 

  157.  
    158. 

  158. /* In the CSS below, the numbers used are the following:
    159. 

  159.     1px: the width of the border
    160. 

  160.     3px: a fudge factor needed for IE5/win (see below)
    161. 

  161.     4px: the width of the border (1px) plus the 3px IE5/win fudge factor
    162. 

  162.     14px: the width or height of the border image
    163. 

  163. */
    164. 

  164. ";
    165. 

  165.         
    166. 

  166.         $css .= $tabs.".".$this->_classSelector."BorderTL,"
    167. 

  167.             ." .".$this->_classSelector."BorderTR,"
    168. 

  168.             ." .".$this->_classSelector."BorderBL,"
    169. 

  169.             ." .".$this->_classSelector."BorderBR {\n";
    170. 

  170.         $css .= $tabs."\twidth: 14px; height: 14px;\n";
    171. 

  171.         $css .= $tabs."\tpadding: 0px; border: 0px;\n";
    172. 

  172.         $css .= $tabs."\tz-index: 99;\n";
    173. 

  173.         $css .= $tabs."}\n";
    174. 

  174.         
    175. 

  175.         $css .= $tabs.".".$this->_classSelector."BorderTL,"
    176. 

  176.             ." .".$this->_classSelector."BorderBL {\n";
    177. 

  177.         $css .= $tabs."\tfloat: left;\n";
    178. 

  178.         $css .= $tabs."\tclear: both;\n";
    179. 

  179.         $css .= $tabs."}\n";
    180. 

  180.         $css .= $tabs.".".$this->_classSelector."BorderTR,"
    181. 

  181.             ." .".$this->_classSelector."BorderBR {\n";
    182. 

  182.         $css .= $tabs."\tfloat: right;\n";
    183. 

  183.         $css .= $tabs."\tclear: right;\n";
    184. 

  184.         $css .= $tabs."}\n";
    185. 

  185.         
    186. 

  186.         $css .= $tabs.".".$this->_classSelector."BorderTL {\n";
    187. 

  187.         $css .= $tabs."\tmargin: 0px 0px 0px 0px;\n";
    188. 

  188.         $css .= $tabs."}\n";
    189. 

  189.         $css .= $tabs.".".$this->_classSelector."BorderTR {\n";
    190. 

  190.         $css .= $tabs."\tmargin: -0px -0px 0px 0px;\n";
    191. 

  191.         $css .= $tabs."}\n";
    192. 

  192.         $css .= $tabs.".".$this->_classSelector."BorderBL {\n";
    193. 

  193.         $css .= $tabs."\tmargin: -14px 0px 0px 0px;\n";
    194. 

  194.         $css .= $tabs."}\n";
    195. 

  195.         $css .= $tabs.".".$this->_classSelector."BorderBR {\n";
    196. 

  196.         $css .= $tabs."\tmargin: -14px 0px 0px 0px;\n";
    197. 

  197.         $css .= $tabs."}\n";
    198. 

  198.         
    199. 

  199.         // Stuff for aligning on IE
    200. 

  200.         $css .= $tabs.".".$this->_classSelector."BorderTL {\n";
    201. 

  201.         $css .= $tabs."\t margin-left: -4px;\n";
    202. 

  202.         $css .= $tabs."\t ma\\rgin-left: -1px;\n";
    203. 

  203.         $css .= $tabs."}\n";
    204. 

  204.         $css .= $tabs."html>body .".$this->_classSelector."BorderTL {\n";
    205. 

  205.         $css .= $tabs."\t margin-left: 0px;\n";
    206. 

  206.         $css .= $tabs."}\n";
    207. 

  207.         $css .= $tabs.".".$this->_classSelector."BorderTR {\n";
    208. 

  208.         $css .= $tabs."\t margin-right: -4px;\n";
    209. 

  209.         $css .= $tabs."\t ma\\rgin-right: -1px;\n";
    210. 

  210.         $css .= $tabs."}\n";
    211. 

  211.         $css .= $tabs."html>body .".$this->_classSelector."BorderTR {\n";
    212. 

  212.         $css .= $tabs."\t margin-right: 0px;\n";
    213. 

  213.         $css .= $tabs."}\n";
    214. 

  214.         $css .= $tabs.".".$this->_classSelector."BorderBL {\n";
    215. 

  215.         $css .= $tabs."\t margin-left: -3px;\n";
    216. 

  216.         $css .= $tabs."\t ma\\rgin-left: 0px;\n";
    217. 

  217.         $css .= $tabs."}\n";
    218. 

  218.         $css .= $tabs."html>body .".$this->_classSelector."BorderBL {\n";
    219. 

  219.         $css .= $tabs."\t margin-left: -0px;\n";
    220. 

  220.         $css .= $tabs."}\n";
    221. 

  221.         $css .= $tabs.".".$this->_classSelector."BorderBR {\n";
    222. 

  222.         $css .= $tabs."\t margin-left: -3px;\n";
    223. 

  223.         $css .= $tabs."\t ma\\rgin-left: 0px;\n";
    224. 

  224.         $css .= $tabs."}\n";
    225. 

  225.         $css .= $tabs."html>body .".$this->_classSelector."BorderBR {\n";
    226. 

  226.         $css .= $tabs."\t margin-left: 0px;\n";
    227. 

  227.         $css .= $tabs."}\n";
    228. 

  228.         
    229. 

  229.         return $css;
    230. 

  230.     }
    231. 

  231.  
    232. 

  232.     /**
    233. 

  233.      * Return HTML to nested inside of the component's block. This includes
    234. 

  234.      * things such as corner images.
    235. 

  235.      *
    236. 

  236.      * See the example below:
    237. 

  237.      *     <pre>
    238. 

  238.      *     <div class='block3'>
    239. 

  239.      *
    240. 

  240.      *        <!-- preHTML start -->
    241. 

  241.      *        <div class="content">
    242. 

  242.      *          <img class="borderTL" src="images/block3_TL.gif" width="14" height="14" />
    243. 

  243.      *          <img class="borderTR" src="images/block3_TR.gif" width="14" height="14" />
    244. 

  244.      *        <!-- preHTML end -->
    245. 

  245.      *        
    246. 

  246.      *            <h1>Hello world! (this is when my component renders itself)</h1>
    247. 

  247.      *
    248. 

  248.      *        <!-- postHTML start -->
    249. 

  249.      *            <div class="roundedCornerSpacer">&nbsp;</div>
    250. 

  250.      *        </div>
    251. 

  251.      *        <div class="bottomCorners">
    252. 

  252.      *          <img class="borderBL" src="images/block3_BL.gif" width="14" height="14" />
    253. 

  253.      *          <img class="borderBR" src="images/block3_BR.gif" width="14" height="14" />
    254. 

  254.      *        </div>
    255. 

  255.      *        <!-- postHTML end -->
    256. 

  256.      *
    257. 

  257.      *    </div>
    258. 

  258.      *    </pre>
    259. 

  259.      * 
    260. 

  260.      * @param string $tabs 
    261. 

  261.      * @return string 
    262. 

  262.      * @access public
    263. 

  263.      * @since 11/22/05
    264. 

  264.      */
    265. 

  265.     function getPreHTML ($tabs) {
    266. 

  266.         $html = $tabs."<div class='".$this->_classSelector."TopCorners'>\n";
    267. 

  267.            $html .= $tabs."\t<img class='".$this->_classSelector."BorderTL' src='"
    268. 

  268.                .$this->getBorderUrl('TopLeft')."' alt='&nbsp;' width='14' height='14' />\n";
    269. 

  269.         $html .= $tabs."\t<img class='".$this->_classSelector."BorderTR' src='"
    270. 

  270.                .$this->getBorderUrl('TopRight')."' alt='&nbsp;' width='14' height='14' />\n";
    271. 

  271.         $html .= $tabs."</div>\n";
    272. 

  272.         $html .= $tabs."<div class='".$this->_classSelector."Content'>\n";
    273. 

  273.         return $html;
    274. 

  274.     }
    275. 

  275.     
    276. 

  276.     /**
    277. 

  277.      * Return HTML to nested inside of the component's block. This includes
    278. 

  278.      * things such as corner images.
    279. 

  279.      *
    280. 

  280.      * See the example below:
    281. 

  281.      *     <pre>
    282. 

  282.      *     <div class='block3'>
    283. 

  283.      *
    284. 

  284.      *        <!-- preHTML start -->
    285. 

  285.      *        <div class="content">
    286. 

  286.      *          <img class="borderTL" src="images/block3_TL.gif" width="14" height="14" />
    287. 

  287.      *          <img class="borderTR" src="images/block3_TR.gif" width="14" height="14" />
    288. 

  288.      *        <!-- preHTML end -->
    289. 

  289.      *        
    290. 

  290.      *            <h1>Hello world! (this is when my component renders itself)</h1>
    291. 

  291.      *
    292. 

  292.      *        <!-- postHTML start -->
    293. 

  293.      *            <div class="roundedCornerSpacer">&nbsp;</div>
    294. 

  294.      *        </div>
    295. 

  295.      *        <div class="bottomCorners">
    296. 

  296.      *          <img class="borderBL" src="images/block3_BL.gif" width="14" height="14" />
    297. 

  297.      *          <img class="borderBR" src="images/block3_BR.gif" width="14" height="14" />
    298. 

  298.      *        </div>
    299. 

  299.      *        <!-- postHTML end -->
    300. 

  300.      *
    301. 

  301.      *    </div>
    302. 

  302.      *    </pre>
    303. 

  303.      * 
    304. 

  304.      * @param string $tabs 
    305. 

  305.      * @return string 
    306. 

  306.      * @access public
    307. 

  307.      * @since 11/22/05
    308. 

  308.      */
    309. 

  309.     function getPostHTML ($tabs) {
    310. 

  310. //         $html = "\n".$tabs."\t<!-- IE5/win puts the margin-bottom of the content div's final element";
    311. 

  311. //         $html .= "\n".$tabs."\tOUTSIDE the containing box (div.content), instead of putting it inside";
    312. 

  312. //         $html .= "\n".$tabs."\tthe containing box\'s edge. So it needs this spacer. -->\n";
    313. 

  313.         $html = $tabs."\t<div class='".$this->_classSelector."Spacer'>&nbsp;</div>\n";
    314. 

  314.         $html .= $tabs."</div>\n";
    315. 

  315. //        $html .= "<!-- end of div.content -->\n";
    316. 

  316.         $html .= $tabs."<div class='".$this->_classSelector."BottomCorners'>\n";
    317. 

  317.         $html .= $tabs."\t<img class='".$this->_classSelector."BorderBL' src='"
    318. 

  318.                .$this->getBorderUrl('BottomLeft')."' alt='&nbsp;' width='14' height='14' />\n";
    319. 

  319.         $html .= $tabs."\t<img class='".$this->_classSelector."BorderBR' src='"
    320. 

  320.                .$this->getBorderUrl('BottomRight')."' alt='&nbsp;' width='14' height='14' />\n";
    321. 

  321.         $html .= $tabs."</div>\n";
    322. 

  322.         
    323. 

  323.         return $html;
    324. 

  324.     }
    325. 

  325. }
    326. 

  326.  
    327. 

  327. ?>
    328.

Documentation generated on Wed, 19 Sep 2007 10:22:12 -0400 by phpDocumentor 1.3.0RC3