1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
|
<?php
/**
* TTabPanel class file.
*
* @author Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Web\UI\WebControls
* @since 3.1.1
*/
namespace Prado\Web\UI\WebControls;
use Prado\TPropertyValue;
use Prado\Exceptions\TInvalidDataValueException;
use Prado\Web\Javascripts\TJavaScript;
/**
* Class TTabPanel.
*
* TTabPanel displays a tabbed panel. Users can click on the tab bar to switching among
* different tab views. Each tab view is an independent panel that can contain arbitrary content.
*
* If the {@link setAutoSwitch AutoSwitch} property is enabled, the user will be able to switch the active view
* to another one just hovering its corresponding tab caption.
*
* A TTabPanel control consists of one or several {@link TTabView} controls representing the possible
* tab views. At any time, only one tab view is visible (active), which is specified by any of
* the following properties:
* - {@link setActiveViewIndex ActiveViewIndex} - the zero-based integer index of the view in the view collection.
* - {@link setActiveViewID ActiveViewID} - the text ID of the visible view.
* - {@link setActiveView ActiveView} - the visible view instance.
* If both {@link setActiveViewIndex ActiveViewIndex} and {@link setActiveViewID ActiveViewID}
* are set, the latter takes precedence.
*
* TTabPanel uses CSS to specify the appearance of the tab bar and panel. By default,
* an embedded CSS file will be published which contains the default CSS for TTabPanel.
* You may also use your own CSS file by specifying the {@link setCssUrl CssUrl} property.
* The following properties specify the CSS classes used for elements in a TTabPanel:
* - {@link setCssClass CssClass} - the CSS class name for the outer-most div element (defaults to 'tab-panel');
* - {@link setTabCssClass TabCssClass} - the CSS class name for nonactive tab div elements (defaults to 'tab-normal');
* - {@link setActiveTabCssClass ActiveTabCssClass} - the CSS class name for the active tab div element (defaults to 'tab-active');
* - {@link setViewCssClass ViewCssClass} - the CSS class for the div element enclosing view content (defaults to 'tab-view');
*
* To use TTabPanel, write a template like following:
* <code>
* <com:TTabPanel>
* <com:TTabView Caption="View 1">
* content for view 1
* </com:TTabView>
* <com:TTabView Caption="View 2">
* content for view 2
* </com:TTabView>
* <com:TTabView Caption="View 3">
* content for view 3
* </com:TTabView>
* </com:TTabPanel>
* </code>
*
* @author Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
* @package Prado\Web\UI\WebControls
* @since 3.1.1
*/
class TTabPanel extends \Prado\Web\UI\WebControls\TWebControl implements \Prado\Web\UI\IPostBackDataHandler
{
private $_dataChanged=false;
/**
* @return string tag name for the control
*/
protected function getTagName()
{
return 'div';
}
/**
* Adds object parsed from template to the control.
* This method adds only {@link TTabView} objects into the {@link getViews Views} collection.
* All other objects are ignored.
* @param mixed object parsed from template
*/
public function addParsedObject($object)
{
if($object instanceof TTabView)
$this->getControls()->add($object);
}
/**
* Returns the index of the active tab view.
* Note, this property may not return the correct index.
* To ensure the correctness, call {@link getActiveView()} first.
* @return integer the zero-based index of the active tab view. If -1, it means no active tab view. Default is 0 (the first view is active).
*/
public function getActiveViewIndex()
{
return $this->getViewState('ActiveViewIndex',0);
}
/**
* @param integer the zero-based index of the current view in the view collection. -1 if no active view.
* @throws TInvalidDataValueException if the view index is invalid
*/
public function setActiveViewIndex($value)
{
$this->setViewState('ActiveViewIndex',TPropertyValue::ensureInteger($value),0);
}
/**
* Returns the ID of the active tab view.
* Note, this property may not return the correct ID.
* To ensure the correctness, call {@link getActiveView()} first.
* @return string The ID of the active tab view. Defaults to '', meaning not set.
*/
public function getActiveViewID()
{
return $this->getViewState('ActiveViewID','');
}
/**
* @param string The ID of the active tab view.
*/
public function setActiveViewID($value)
{
$this->setViewState('ActiveViewID',$value,'');
}
/**
* Returns the currently active view.
* This method will examin the ActiveViewID, ActiveViewIndex and Views collection to
* determine which view is currently active. It will update ActiveViewID and ActiveViewIndex accordingly.
* @return TTabView the currently active view, null if no active view
* @throws TInvalidDataValueException if the active view ID or index set previously is invalid
*/
public function getActiveView()
{
$activeView=null;
$views=$this->getViews();
if(($id=$this->getActiveViewID())!=='')
{
if(($index=$views->findIndexByID($id))>=0)
$activeView=$views->itemAt($index);
else
throw new TInvalidDataValueException('tabpanel_activeviewid_invalid',$id);
}
else if(($index=$this->getActiveViewIndex())>=0)
{
if($index<$views->getCount())
$activeView=$views->itemAt($index);
else
throw new TInvalidDataValueException('tabpanel_activeviewindex_invalid',$index);
}
else
{
foreach($views as $index=>$view)
{
if($view->getActive())
{
$activeView=$view;
break;
}
}
}
if($activeView!==null)
$this->activateView($activeView);
return $activeView;
}
/**
* @param TTabView the view to be activated
* @throws TInvalidOperationException if the view is not in the view collection
*/
public function setActiveView($view)
{
if($this->getViews()->indexOf($view)>=0)
$this->activateView($view);
else
throw new TInvalidOperationException('tabpanel_view_inexistent');
}
/**
* @return bool status of automatic tab switch on hover
*/
public function getAutoSwitch()
{
return TPropertyValue::ensureBoolean($this->getViewState('AutoSwitch'));
}
/**
* @param bool whether to enable automatic tab switch on hover
*/
public function setAutoSwitch($value)
{
$this->setViewState('AutoSwitch',TPropertyValue::ensureBoolean($value));
}
/**
* @return string URL for the CSS file including all relevant CSS class definitions. Defaults to ''.
*/
public function getCssUrl()
{
return $this->getViewState('CssUrl','default');
}
/**
* @param string URL for the CSS file including all relevant CSS class definitions.
*/
public function setCssUrl($value)
{
$this->setViewState('CssUrl',TPropertyValue::ensureString($value),'');
}
/**
* @return string CSS class for the whole tab control div. Defaults to 'tab-panel'.
*/
public function getCssClass()
{
$cssClass=parent::getCssClass();
return $cssClass===''?'tab-panel':$cssClass;
}
/**
* @return string CSS class for the currently displayed view div. Defaults to 'tab-view'.
*/
public function getViewCssClass()
{
return $this->getViewStyle()->getCssClass();
}
/**
* @param string CSS class for the currently displayed view div.
*/
public function setViewCssClass($value)
{
$this->getViewStyle()->setCssClass($value);
}
/**
* @return TStyle the style for all the view div
*/
public function getViewStyle()
{
if(($style=$this->getViewState('ViewStyle',null))===null)
{
$style=new TStyle;
$style->setCssClass('tab-view');
$this->setViewState('ViewStyle',$style,null);
}
return $style;
}
/**
* @return string CSS class for non-active tabs. Defaults to 'tab-normal'.
*/
public function getTabCssClass()
{
return $this->getTabStyle()->getCssClass();
}
/**
* @param string CSS class for non-active tabs.
*/
public function setTabCssClass($value)
{
$this->getTabStyle()->setCssClass($value);
}
/**
* @return TStyle the style for all the inactive tab div
*/
public function getTabStyle()
{
if(($style=$this->getViewState('TabStyle',null))===null)
{
$style=new TStyle;
$style->setCssClass('tab-normal');
$this->setViewState('TabStyle',$style,null);
}
return $style;
}
/**
* @return string CSS class for the active tab. Defaults to 'tab-active'.
*/
public function getActiveTabCssClass()
{
return $this->getActiveTabStyle()->getCssClass();
}
/**
* @param string CSS class for the active tab.
*/
public function setActiveTabCssClass($value)
{
$this->getActiveTabStyle()->setCssClass($value);
}
/**
* @return TStyle the style for the active tab div
*/
public function getActiveTabStyle()
{
if(($style=$this->getViewState('ActiveTabStyle',null))===null)
{
$style=new TStyle;
$style->setCssClass('tab-active');
$this->setViewState('ActiveTabStyle',$style,null);
}
return $style;
}
/**
* Activates the specified view.
* If there is any other view currently active, it will be deactivated.
* @param TTabView the view to be activated. If null, all views will be deactivated.
*/
protected function activateView($view)
{
$this->setActiveViewIndex(-1);
$this->setActiveViewID('');
foreach($this->getViews() as $index=>$v)
{
if($view===$v)
{
$this->setActiveViewIndex($index);
$this->setActiveViewID($view->getID(false));
$view->setActive(true);
}
else
$v->setActive(false);
}
}
/**
* Loads user input data.
* This method is primarly used by framework developers.
* @param string the key that can be used to retrieve data from the input data collection
* @param array the input data collection
* @return boolean whether the data of the control has been changed
*/
public function loadPostData($key,$values)
{
if(($index=$values[$this->getClientID().'_1'])!==null)
{
$index=(int)$index;
$currentIndex=$this->getActiveViewIndex();
if($currentIndex!==$index)
{
$this->setActiveViewID(''); // clear up view ID
$this->setActiveViewIndex($index);
return $this->_dataChanged=true;
}
}
return false;
}
/**
* Raises postdata changed event.
* This method is required by {@link \Prado\Web\UI\IPostBackDataHandler} interface.
* It is invoked by the framework when {@link getActiveViewIndex ActiveViewIndex} property
* is changed on postback.
* This method is primarly used by framework developers.
*/
public function raisePostDataChangedEvent()
{
// do nothing
}
/**
* Returns a value indicating whether postback has caused the control data change.
* This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
* @return boolean whether postback has caused the control data change. False if the page is not in postback mode.
*/
public function getDataChanged()
{
return $this->_dataChanged;
}
/**
* Adds attributes to renderer.
* @param THtmlWriter the renderer
*/
protected function addAttributesToRender($writer)
{
$writer->addAttribute('id',$this->getClientID());
$this->setCssClass($this->getCssClass());
parent::addAttributesToRender($writer);
}
/**
* Registers CSS and JS.
* This method is invoked right before the control rendering, if the control is visible.
* @param mixed event parameter
*/
public function onPreRender($param)
{
parent::onPreRender($param);
$this->getActiveView(); // determine the active view
$this->registerStyleSheet();
$page=$this->getPage();
$page->registerRequiresPostData($this);
$page->registerRequiresPostData($this->getClientID()."_1");
}
/**
* Registers the CSS relevant to the TTabControl.
* It will register the CSS file specified by {@link getCssUrl CssUrl}.
* If that is not set, it will use the default CSS.
*/
protected function registerStyleSheet()
{
$url = $this->getCssUrl();
if($url === '') {
return;
}
if($url === 'default') {
$url = $this->getApplication()->getAssetManager()->publishFilePath(dirname(__FILE__).DIRECTORY_SEPARATOR.'assets'.DIRECTORY_SEPARATOR.'tabpanel.css');
}
if($url !== '') {
$this->getPage()->getClientScript()->registerStyleSheetFile($url, $url);
}
}
/**
* Registers the relevant JavaScript.
*/
protected function registerClientScript()
{
$id=$this->getClientID();
$options=TJavaScript::encode($this->getClientOptions());
$className=$this->getClientClassName();
$cs=$this->getPage()->getClientScript();
$cs->registerPradoScript('tabpanel');
$code="new $className($options);";
$cs->registerEndScript("prado:$id", $code);
// ensure an item is always active and visible
$index = $this->getActiveViewIndex();
if(!$this->getViews()->itemAt($index)->Visible)
$index=0;
$cs->registerHiddenField($id.'_1', $index);
}
/**
* Gets the name of the javascript class responsible for performing postback for this control.
* This method overrides the parent implementation.
* @return string the javascript class name
*/
protected function getClientClassName()
{
return 'Prado.WebUI.TTabPanel';
}
/**
* @return array the options for JavaScript
*/
protected function getClientOptions()
{
$options['ID'] = $this->getClientID();
$options['ActiveCssClass'] = $this->getActiveTabCssClass();
$options['NormalCssClass'] = $this->getTabCssClass();
$viewIDs = array();
$viewVis = array();
foreach($this->getViews() as $view)
{
$viewIDs[] = $view->getClientID();
$viewVis[] = $view->getVisible();
}
$options['Views'] = $viewIDs;
$options['ViewsVis'] = $viewVis;
$options['AutoSwitch'] = $this->getAutoSwitch();
return $options;
}
/**
* Creates a control collection object that is to be used to hold child controls
* @return TTabViewCollection control collection
*/
protected function createControlCollection()
{
return new TTabViewCollection($this);
}
/**
* @return TTabViewCollection list of {@link TTabView} controls
*/
public function getViews()
{
return $this->getControls();
}
public function render($writer)
{
$this->registerClientScript();
parent::render($writer);
}
/**
* Renders body contents of the tab control.
* @param THtmlWriter the writer used for the rendering purpose.
*/
public function renderContents($writer)
{
$views=$this->getViews();
if($views->getCount()>0)
{
$writer->writeLine();
// render tab bar
foreach($views as $view)
{
$view->renderTab($writer);
$writer->writeLine();
}
// render tab views
foreach($views as $view)
{
$view->renderControl($writer);
$writer->writeLine();
}
}
}
}
|