summaryrefslogtreecommitdiffstats
blob: 6d6bf28186bb7b69cf80354108fa9abbe679c6a6 (plain)
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
/*******************************************************************************
 * Copyright (c) 2011 SunGard CSA LLC and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    SunGard CSA LLC - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.stardust.ui.web.common.app;

import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;

import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.ValueChangeEvent;
import javax.faces.model.SelectItem;
import javax.servlet.http.HttpServletRequest;

import org.eclipse.stardust.ui.web.common.Constants;
import org.eclipse.stardust.ui.web.common.PreferencePage;
import org.eclipse.stardust.ui.web.common.PreferencesDefinition;
import org.eclipse.stardust.ui.web.common.ViewDefinition;
import org.eclipse.stardust.ui.web.common.app.View.ViewState;
import org.eclipse.stardust.ui.web.common.app.messaging.MessageProcessor;
import org.eclipse.stardust.ui.web.common.configuration.ConfigurationConstants;
import org.eclipse.stardust.ui.web.common.configuration.UserPreferencesEntries;
import org.eclipse.stardust.ui.web.common.configuration.UserPreferencesHelper;
import org.eclipse.stardust.ui.web.common.event.PerspectiveEvent.PerspectiveEventType;
import org.eclipse.stardust.ui.web.common.event.ViewDataEvent;
import org.eclipse.stardust.ui.web.common.event.ViewDataEventHandler;
import org.eclipse.stardust.ui.web.common.event.ViewEvent.ViewEventType;
import org.eclipse.stardust.ui.web.common.log.LogManager;
import org.eclipse.stardust.ui.web.common.log.Logger;
import org.eclipse.stardust.ui.web.common.message.MessageDialog;
import org.eclipse.stardust.ui.web.common.spi.env.RuntimeEnvironmentInfoProvider;
import org.eclipse.stardust.ui.web.common.spi.user.User;
import org.eclipse.stardust.ui.web.common.spi.user.UserProvider;
import org.eclipse.stardust.ui.web.common.util.AbstractMessageBean;
import org.eclipse.stardust.ui.web.common.util.DateUtils;
import org.eclipse.stardust.ui.web.common.util.FacesUtils;
import org.eclipse.stardust.ui.web.common.util.MessagePropertiesBean;
import org.eclipse.stardust.ui.web.common.util.SessionRendererHelper;
import org.eclipse.stardust.ui.web.common.util.StringUtils;
import org.springframework.beans.factory.InitializingBean;

import com.icesoft.faces.component.paneltabset.TabChangeEvent;
import com.icesoft.faces.component.paneltabset.TabChangeListener;
import com.icesoft.faces.context.effects.JavascriptContext;
import com.icesoft.faces.webapp.http.servlet.ServletExternalContext;


/**
 * @author Subodh.Godbole
 *
 */
public class PortalApplication
      implements TabChangeListener, UserPreferencesEntries, ConfigurationConstants, Serializable, InitializingBean,
      Constants
{
   private static final long serialVersionUID = 1L;

   public static final String BEAN_NAME = "ippPortalApp";

   private static final Logger trace = LogManager.getLogger(PortalApplication.class);

   public static final int TAB_DISPLAY_MODE = 0;

   public static final int GRID_DISPLAY_MODE = 1;

   public static final int VERTICAL_SPLIT_DISPLAY_MODE = 2;

   public static final int HORIZONTAL_SPLIT_DISPLAY_MODE = 3;

   public static final String PIN_VIEW_MODE_VERTICAL = "vertical";

   public static final String PIN_VIEW_MODE_HORIZONTAL = "horizontal";

   private PortalUiController portalUiController;

   private boolean fullScreenModeActivated;

   private boolean launchPanelsActivated;

   private int displayMode;

   private int viewIndex;

   private List<View> activeViewBreadCrumb;

   private List<View> displayedViews;

   private List<View> overflowedViews;

   private View dummyViewForOverflowTab;

   private boolean showOverflowTabs;

   private int maxTabDisplay = -1;

   private boolean pinViewOpened = false;

   private String pinViewOrientation;

   private View pinView;

   private ArrayList<View> focusViewStack = new ArrayList<View>();

   private List<String> skinFiles;

   // Only one view can be in focus i.e. active in entire portal
   // This view can exist anywhere - TabSet, PinView
   private View activeView;

   private UserProvider userProvider;

   private PortalApplicationEventScript portalApplicationEventScript;

   private TimeZone clientTimeZone = null;

   private RuntimeEnvironmentInfoProvider runtimeEnvironmentInfoProvider;
   private String version;
   private String copyrightMessage;

   private String logoutUri;

   /**
    *
    */
   public PortalApplication()
   {
   }

   /**
    * @return
    */
   public static PortalApplication getInstance()
   {
      return (PortalApplication) FacesUtils.getBeanFromContext("ippPortalApp");
   }

   /**
    * @throws Exception
    */
   public void afterPropertiesSet() throws Exception
   {
   	  // eagerly instantiate label provider to be able to access it via REST API
      MessagePropertiesBean.getInstance();

      launchPanelsActivated = true;
      fullScreenModeActivated = false;
      displayMode = TAB_DISPLAY_MODE;

      dummyViewForOverflowTab = new View(null, "/dummy.xhtml");

      refreshSkin();

      loadPerspective();

      retrieveRuntimeEnvInfo();

      logoutUri = (String) FacesContext.getCurrentInstance().getExternalContext()
            .getInitParameter(CONTEXT_PARAM_LOGOUT_URI);

      SessionRendererHelper.addCurrentSession(SessionRendererHelper.getPortalSessionRendererId(getLoggedInUser()));
   }

   /**
    * @return
    */
   public User getLoggedInUser()
   {
      return  userProvider.getUser();
   }

   /**
    * @return
    */
   public PreferencePage getHelpDocPreference()
   {
      if(getPortalUiController().getPerspective().getPreferences() != null)
      {
         return getPortalUiController().getPerspective().getPreferences().getPreference(
               PreferencesDefinition.PREF_HELP_DOCUMENTATION);
      }

      return null;
   }

   /**
    * @return
    */
   public boolean isLaunchPanelsActivated()
   {
      return launchPanelsActivated;
   }

   /**
    *
    */
   public void activateLaunchPanels()
   {
      if (!isLaunchPanelsActivated())
      {
         launchPanelsActivated = true;

         getPortalUiController().broadcastNonVetoablePerspectiveEvent(PerspectiveEventType.LAUNCH_PANELS_ACTIVATED);

         getPortalUiController().broadcastVetoableViewEvent(getFocusView(),
               ViewEventType.LAUNCH_PANELS_ACTIVATED);

         if (isPinViewOpened())
         {
            getPortalUiController().broadcastVetoableViewEvent(getPinView(),
                  ViewEventType.LAUNCH_PANELS_ACTIVATED);
         }
      }
   }

   /**
    *
    */
   public void deactivateLaunchPanels()
   {
      if (isLaunchPanelsActivated())
      {
         launchPanelsActivated = false;

         getPortalUiController().broadcastVetoableViewEvent(getFocusView(),
               ViewEventType.LAUNCH_PANELS_DEACTIVATED);

         getPortalUiController().broadcastNonVetoablePerspectiveEvent(PerspectiveEventType.LAUNCH_PANELS_DEACTIVATED);

         if (isPinViewOpened())
         {
            getPortalUiController().broadcastVetoableViewEvent(getPinView(),
                  ViewEventType.LAUNCH_PANELS_DEACTIVATED);
         }
      }
   }

   /**
    *
    */
   public void activateFullScreenMode()
   {
      if (!isFullScreenModeActivated())
      {
         getPortalUiController().broadcastNonVetoablePerspectiveEvent(PerspectiveEventType.LAUNCH_PANELS_DEACTIVATED);

         boolean success = getPortalUiController().broadcastVetoableViewEvent(getFocusView(),
               ViewEventType.TO_BE_FULL_SCREENED);
         if(!success)
         {
            return;
         }

         FacesContext context = FacesContext.getCurrentInstance();
         String identityUrl = (String) context.getExternalContext().getRequestParameterMap().get("identityUrl");

         View newView;
         if (StringUtils.isNotEmpty(identityUrl))
         {
            newView = getPortalUiController().findView(identityUrl);
         }
         else
         {
            newView = getActiveView();
         }

         if (null != newView)
         {
            getPortalUiController().setFocusView(newView);
            setActiveView(newView);

            fullScreenModeActivated = true;

            // Vetoed not processed here. This is FYI only event,
            // As this view already returned success for TO_BE_FULL_SCREENED
            getPortalUiController().broadcastNonVetoableViewEvent(getFocusView(),
                  ViewEventType.FULL_SCREENED);

            // Required to refresh page
            FacesUtils.refreshPage();
         }
      }
   }

   /**
    * @return
    */
   public boolean isFullScreenModeActivated()
   {
      return fullScreenModeActivated;
   }

   /**
    *
    */
   public void deactivateFullScreenMode()
   {
      if (isFullScreenModeActivated())
      {
         // broadcast activation events
         setFocusView(getFocusView());

         boolean success = getPortalUiController().broadcastVetoableViewEvent(getFocusView(),
               ViewEventType.TO_BE_RESTORED_TO_NORMAL);
         if(!success)
         {
            return;
         }

         fullScreenModeActivated = false;

         getPortalUiController().broadcastNonVetoablePerspectiveEvent(PerspectiveEventType.LAUNCH_PANELS_ACTIVATED);

         // Vetoed not processed here. This is FYI only event,
         // As this view already returned success for TO_BE_FULL_SCREENED
         getPortalUiController().broadcastNonVetoableViewEvent(getFocusView(),
               ViewEventType.RESTORED_TO_NORMAL);

         FacesUtils.refreshPage();
      }
   }

   /**
    *
    * @return
    */
   public String getPortalHeader()
   {
      return FacesUtils.getPortalTitle();
   }

   /**
    * @param viewDef
    * @param url
    * @param messageBean
    * @return
    */
   public View createView(ViewDefinition viewDef, String url,
         AbstractMessageBean messageBean)
   {
      return getPortalUiController().createView(viewDef, url, messageBean);
   }

   /**
    * @param viewDef
    * @param viewKey
    * @param viewParams
    * @param msgBean
    * @param nested
    * @return
    */
   public View createView(ViewDefinition viewDef, String viewKey,
         Map<String, Object> viewParams, AbstractMessageBean msgBean, boolean nested)
   {
      return getPortalUiController().createView(viewDef, viewKey, viewParams, msgBean,
            nested);
   }

   /**
    * @param viewId
    * @param viewKey
    * @param viewParams
    * @param messageBean
    * @param nestedView
    * @return
    */
   public View createView(String viewId, String viewKey,
         Map<String, Object> viewParams, AbstractMessageBean messageBean, boolean nestedView)
   {
      return getPortalUiController().createView(viewId, viewKey, viewParams,
            messageBean, nestedView);
   }

   /**
    * nested parameter should be false when calling this. In short nesting is not supported in this API
    */
   public void openInFocusTab()
   {
      View focusView = getFocusView();
      int focusViewIndex = viewIndex;
      closeView(focusView);

      View newView = getPortalUiController().openView();
      addToDisplayedViews(newView, true, focusViewIndex);
   }

   /**
    * @param viewId
    * @param params
    * @param msgBean
    */
   public void openInFocusTab(String viewId, Map<String, Object> params, AbstractMessageBean msgBean)
   {
      View focusView = getFocusView();
      int focusViewIndex = viewIndex;
      closeView(focusView);

      View newView = getPortalUiController().openViewById(viewId, params, msgBean, false);
      addToDisplayedViews(newView, true, focusViewIndex);
   }

   /**
    *
    */
   public void openView()
   {
      addToDisplayedViews(getPortalUiController().openView(), true);
   }

   /**
    * @param viewUrl
    * @param messageBean
    */
   public void openView(String viewUrl, AbstractMessageBean messageBean)
   {
      addToDisplayedViews(getPortalUiController().openView(viewUrl, messageBean), true);
   }

   /**
    * @param viewDef
    * @param viewUrl
    * @param messageBean
    * @param nested
    * @return
    */
   public View openView(ViewDefinition viewDef, String viewUrl, AbstractMessageBean messageBean, boolean nested)
   {
      View openedView = getPortalUiController().openView(viewDef, viewUrl, messageBean, nested);

      if (null != openedView)
      {
         addToDisplayedViews(openedView, true);
      }

      return openedView;
   }

   /**
    * @param viewUrl
    * @param messageBean
    * @param nestedView
    */
   public void openView(String viewUrl, AbstractMessageBean messageBean,
         boolean nestedView)
   {
      addToDisplayedViews(getPortalUiController().openView(viewUrl, messageBean,
            nestedView), true);
   }

   /**
    * @param viewId
    * @param params
    * @param msgBean
    * @param nested
    */
   public void openViewById(String viewId, Map<String, Object> params, AbstractMessageBean msgBean, boolean nested)
   {
      addToDisplayedViews(getPortalUiController().openViewById(viewId, params, msgBean, nested), true);
   }

   /**
    * Constructor for backward-compatibility
    * @param viewId
    * @param viewKey
    * @param msgBean
    */
   @Deprecated
   public void openViewById(String viewId, String viewKey, AbstractMessageBean msgBean)
   {
      addToDisplayedViews(getPortalUiController().openViewById(viewId, viewId, null,
            msgBean, false), true);
   }

   /**
    * Constructor for backward-compatibility
    * @param viewId
    * @param viewKey
    * @param viewParams
    * @param msgBean
    */
   @Deprecated
   public void openViewById(String viewId, String viewKey,
         Map<String, Object> viewParams, AbstractMessageBean msgBean)
   {
      addToDisplayedViews(getPortalUiController().openViewById(viewId, viewId,
            viewParams, msgBean, false), true);
   }

   /**
    * @param viewId
    * @param viewKey
    * @param params
    * @param msgBean
    * @param nestedView
    * @return
    */
   public View openViewById(String viewId, String viewKey, Map<String, Object> params, AbstractMessageBean msgBean,
         boolean nestedView, int viewIndex)
   {
      View view = getPortalUiController().openViewById(viewId, viewKey, params, msgBean, nestedView);
      addToDisplayedViews(view, true, viewIndex);
      return view;
   }

   /**
    * @param viewId
    * @param viewKey
    * @param params
    * @param msgBean
    * @param nestedView
    * @return
    */
   public View openViewById(String viewId, String viewKey, Map<String, Object> params,
         AbstractMessageBean msgBean, boolean nestedView)
   {
      View view = getPortalUiController().openViewById(viewId, viewKey, params, msgBean, nestedView);
      addToDisplayedViews(view, true);
      return view;
   }

   /**
    * @param viewId
    * @param viewKey
    * @return
    */
   public View getViewById(String viewId, String viewKey)
   {
      return getPortalUiController().getViewById(viewId, viewKey);
   }

   /**
    *
    */
   public void selectView()
   {
      getPortalUiController().selectView();
      addToDisplayedViews(getPortalUiController().getFocusView());
   }

   /**
    * @param event
    */
   public void selectionChange(ValueChangeEvent event)
   {
      if (event.getNewValue() == null || ((String) event.getNewValue()).length() == 0)
      {
         setFocusView(null);
      }
      else
      {
         getPortalUiController().setFocusView(
               getPortalUiController().findView((String) event.getNewValue()));
         addToDisplayedViews(getPortalUiController().findView(
               (String) event.getNewValue()));
      }
   }

   /**
    * @return
    */
   public View getFocusView()
   {
      return getPortalUiController().getFocusView();
   }

   /**
    * @param focusView
    */
   public boolean setFocusView(View focusView)
   {
      if(getPortalUiController().setFocusView(focusView))
      {
         addToDisplayedViews(focusView);
         return true;
      }

      return false;
   }

   /**
    * @param view
    */
   public void setActiveView(View view)
   {
      activeView = view;
      getPortalUiController().setActiveView(view);
      setActiveViewBreadCrumb();
   }

   /**
    * @return
    */
   public List<View> getOpenViews()
   {
      List<View> openViews = getPortalUiController().getOpenViews();

      List<View> result = new ArrayList<View>(openViews.size());
      for (View view : openViews)
      {
         if(view != pinView)
            result.add(view);
      }
      return result;
   }

   /**
    * @return
    */
   public void printOpenViews()
   {
      if (trace.isDebugEnabled())
      {
         trace.debug("Open Views::");
         List<View> openViews = getOpenViews();
         for (View view : openViews)
         {
            trace.debug("\t" + view);
         }
      }
   }

   /**
    *
    */
   public void setActiveViewBreadCrumb()
   {
      List<View> views = new ArrayList<View>();

      View view = getActiveView();
      if (view != null)
      {
         view = view.getOpenerView();

         while (view != null)
         {
            views.add(view);
            if (view == view.getOpenerView())
            {
               break;
            }
            view = view.getOpenerView();
         }
      }

      // Reverse the List
      activeViewBreadCrumb = new ArrayList<View>();
      for (int i = views.size() - 1; i >= 0; i-- )
      {
         activeViewBreadCrumb.add(views.get(i));
      }
   }

   /**
    * @return
    */
   public int getViewIndex()
   {
      return viewIndex;
   }

   /**
    * @param index
    */
   public void setViewIndex(int index)
   {
      this.viewIndex = index;
      setActiveView(displayedViews.get(this.viewIndex));
      setActiveViewBreadCrumb();
   }

   /**
    * @param arg0
    * @throws AbortProcessingException
    */
   public void processTabChange(TabChangeEvent arg0) throws AbortProcessingException
   {
      // If Tab Closed is Focus Tab then New and Old indexes are same
      // Ignore this event
      if (arg0.getNewTabIndex() != arg0.getOldTabIndex())
      {
         int index = arg0.getNewTabIndex();
         boolean success = setFocusView(getDisplayedViews().get(index));
         if(!success)
         {
            // Reset index back
            setViewIndex(arg0.getOldTabIndex());
         }
      }
   }

   /**
    * @param arg0
    * @throws AbortProcessingException
    */
   public void processPinViewTabChange(TabChangeEvent arg0) throws AbortProcessingException
   {
      // As we only have one view as pin view
      setActiveView(pinView);
   }

   /**
    * @return
    */
   public List<SelectItem> getItems()
   {
      List<SelectItem> list = new ArrayList<SelectItem>();

      for (int n = 0; n < getOpenViews().size(); ++n)
      {
         list.add(new SelectItem(getOpenViews().get(n).getUrl(), getOpenViews().get(n)
               .getLabel()));
      }

      return list;
   }

   /**
    * @return
    */
   public int getOpenViewsSize()
   {
      return getOpenViews().size();
   }

   /**
    * @return
    */
   public int getDisplayedViewsSize()
   {
      return displayedViews != null ? displayedViews.size() : 0;
   }

   /**
    * @return
    */
   public int getOverflowedViewsSize()
   {
      return overflowedViews != null ? overflowedViews.size() : 0;
   }

   /**
    * @return
    */
   public boolean getViewsOpened()
   {
      return getOpenViews().size() > 0;
   }

   /**
    * @return
    */
   public View getFirstView()
   {
      if (getOpenViews().size() >= 1)
      {
         return getOpenViews().get(0);
      }

      return null;
   }

   /**
    * @return
    */
   public View getSecondView()
   {
      if (getOpenViews().size() >= 2)
      {
         return getOpenViews().get(1);
      }

      return null;
   }

   /**
    * @return
    */
   public boolean getMoreThanTwoViewsOpened()
   {
      return getOpenViews().size() > 2;
   }

   /**
    *
    */
   public void closeAllViews()
   {
      pinViewOpened = false;
      pinView = null;

      List<View> allViews = getOpenViews();

      for (View view : allViews)
      {
         closeView(view);
      }

      addToDisplayedViews(getLastFocusView());
   }

   /**
    *
    */
   public void closeFocusView()
   {
      View closedView = getFocusView();
      boolean closed = getPortalUiController().closeFocusView();
      if (closed)
      {
         handleViewClose(closedView, closedView, false);
      }
   }

   /**
    *
    */
   public void closeView()
   {
      View focusView = getFocusView();
      View closedView = getPortalUiController().closeView();

      if (null != closedView)
      {
         handleViewClose(closedView, focusView, false);
      }
   }

   /**
    * @param view
    * @return
    */
   public void closeView(View view)
   {
      closeView(view, false);
   }

   /**
    * @param view
    * @param force
    */
   public void closeView(View view, boolean force)
   {
      if (ViewState.CLOSED == view.getViewState())
      {
         return; // Already Closed
      }
      View focusView = getFocusView();
      if (getPortalUiController().closeView(view, force))
      {
         handleViewClose(view, focusView, force);
      }
   }


   /**
    *
    */
   public void openPinViewHorizontal()
   {
      checkAndOpenPinViewInNewMode(PIN_VIEW_MODE_HORIZONTAL);
   }

   /**
    *
    */
   public void openPinViewVertical()
   {
      checkAndOpenPinViewInNewMode(PIN_VIEW_MODE_VERTICAL);
   }

   /**
    *
    */
   public void restorePinView()
   {
      if(pinViewOpened)
      {
         togglePinView();
      }
   }

   /**
    * Renders the Portal Session using Session Renderer
    */
   public void renderPortalSession()
   {
      SessionRendererHelper.render(SessionRendererHelper.getPortalSessionRendererId(getLoggedInUser()));
   }

   /**
    * If UI is already Pinned, Restore Pin View and Focus View too
    * And then Pin UI again on Focus View with new mode
    * @param mode
    */
   private void checkAndOpenPinViewInNewMode(String mode)
   {
      if (pinViewOpened)
      {
         View focusView = getFocusView();
         restorePinView();
         setFocusView(focusView);
      }

      pinViewOrientation = mode;
      togglePinView();
   }

   /**
    * @return
    */
   public void logout()
   {
      String script=null;
      // Close All Open Views
      closeAllViews();
      // If All Views are successfully closed, then fire logout
      if (getOpenViewsSize() == 0)
      {
         // don't directly logout, but redirect main page towards logout
         String logoutScript = "parent.BridgeUtils.logout(true);";
         //JavascriptContext.addJavascriptCall(FacesContext.getCurrentInstance(), logoutScript);
         addEventScript(logoutScript); // This is required since addJavascriptCall does not work if JSF Page refresh is involved
         SessionRendererHelper.removeCurrentSession(SessionRendererHelper.getPortalSessionRendererId(getLoggedInUser()));
      }
      else
      {
         script = "parent.BridgeUtils.showAlert('Not all Views got closed successully. Cannot logout...');";
      }
      addEventScript(script);
   }

   /**
    * This resets the window size to 98% so that the new view's width can be recalculated correctly.
    * Without this, the second view of lesser wide would still assume the same width as the previous view.
    */
   private void resetWindowWidth()
   {
      PortalApplicationEventScript.getInstance().setResetWindowWidth(true);
   }

   /**
    *
    */
   private void togglePinView()
   {
      if(!pinViewOpened)
      {
         boolean success = getPortalUiController().broadcastVetoableViewEvent(getFocusView(),
               ViewEventType.TO_BE_PINNED);
         if(!success)
         {
            return;
         }
      }

      pinViewOpened = !pinViewOpened;
      launchPanelsActivated = !pinViewOpened;

      if(pinViewOpened)
      {
         if(fullScreenModeActivated)
            fullScreenModeActivated = false;

         pinView = getFocusView();
         int index = displayedViews.indexOf(pinView);
         removeFromDisplayedViews(pinView);

         View nextFocusView = index < displayedViews.size()
               ? displayedViews.get(index)
               : displayedViews.get(displayedViews.size()-1);
         setFocusView(nextFocusView);

         // Make pin view as Active
         setActiveView(pinView);

         // Vetoed not processed here. This is FYI only event,
         // As this view already returned success for TO_BE_PINNED
         getPortalUiController().broadcastNonVetoableViewEvent(pinView, ViewEventType.PINNED);
      }
      else
      {
         View sfView = pinView;
         pinView = null;
         setFocusView(sfView);
      }
   }

   /**
    * @param view
    * @param justOpened
    * @param viewIndex
    */
   private void addToDisplayedViews(View view, boolean justOpened, int viewIndex)
   {
      resetWindowWidth();
      if(displayedViews == null)
         displayedViews = new ArrayList<View>();

      if(view != null)
      {
         if(pinView != view)
         {
            if(!displayedViews.contains(view))
            {
               displayedViews.remove(dummyViewForOverflowTab);
               if (-1 == viewIndex || viewIndex >= displayedViews.size())
               {
                  displayedViews.add(view);
               }
               else
               {
                  displayedViews.add(viewIndex, view);
               }

               if(getMaxTabDisplay() < displayedViews.size())
               {
                  displayedViews.remove(0);
               }

               buildOverflowViews();

               addDummyOverflowView();
            }

            int index = view != null ? displayedViews.indexOf(view) : -1;
            setViewIndex(index);
            if(index >= 0)
               addToFocusViewStack(displayedViews.get(index));
         }
         else if(pinView == view)
         {
            // Set the last focus view back to focus
            getPortalUiController().setFocusView(getLastFocusView());
            setActiveView(view);
         }

         if(justOpened)
         {
            firePostOpenLifeCycleEvent(view);
         }

         handleViewOpenPanama(view);
      }
      else
      {
         if(getOpenViewsSize() == 0)
         {
            setActiveView(null);
         }
      }
   }

   /**
    * @param view
    */
   private void handleViewOpenPanama(View view)
   {
      if (StringUtils.isEmpty(view.getParamValue("standaloneMode")))
      {
         ExternalContext externalContext = FacesContext.getCurrentInstance().getExternalContext();
         String contextPath = externalContext.getRequestContextPath();

         String url = "singleViewId=_PERSPECTIVE_ID_::_VIEW_ID_&standaloneMode=true&singleViewKey=_VIEW_KEY_";
         url = StringUtils.replace(url, "_PERSPECTIVE_ID_", encodeUrl(view.getDefinition().getDefinedIn()));
         url = StringUtils.replace(url, "_VIEW_ID_", encodeUrl(view.getDefinition().getName()));
         url = StringUtils.replace(url, "_VIEW_KEY_", encodeUrl(view.getViewKey()));

         if (externalContext instanceof ServletExternalContext)
         {
            HttpServletRequest request = (HttpServletRequest) externalContext.getRequest();
            String urlBase = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort()
                  + contextPath + "/plugins/common/portalSingleViewMain.iface?";
            url = urlBase + url;
            
            // Protocol - Include ending with FrameAdapter.xhtml are HTML based Views
            processPanamaCall(view, url, !view.getDefinition().getInclude().endsWith("FrameAdapter.xhtml"));
         }
         else
         {
            trace.error("Other than Servlet Context is not Supported");
         }
      }
      else // Comes here when view is opened from Mega Menu
      {
         // Currently only one "Portal Configuration"
         // TODO
         String html5FWViewId = "/ippPortal/configurationTreeView";
         view.getViewParams().put("html5FWViewId", html5FWViewId);
      }
   }

   /**
    * @param view
    * @param url
    * @param ext
    */
   public void processPanamaCall(View view, String url, Boolean ext)
   {
      String viewId = "";
      if (ext)
      {
         viewId = "Ext/:type/:id";
      }
      else
      {
         if (StringUtils.isEmpty(view.getViewKey()))
         {
            return;
         }

         viewId = "Int/" + view.getDefinition().getName() + "/:id";
      }

      String typeId = view.getDefinition().getName();
      String id =  StringUtils.isNotEmpty(view.getViewKey()) ? view.getViewKey() : "";

      // Save HTML5 FW View Id, for to be used at the time of closing
      String html5FWViewId = "/ippPortal/configurationTreeView/" + viewId;
      html5FWViewId = StringUtils.replace(html5FWViewId, ":type", typeId);
      html5FWViewId = StringUtils.replace(html5FWViewId, ":id", id);
      view.getViewParams().put("html5FWViewId", html5FWViewId);

      String script = "parent.BridgeUtils.View.openView('" + html5FWViewId + "', '" + viewId
            + "', {type: '_TYPE_', id: '_ID_', label: '_LABEL_', icon: '_ICON_', url: '_URL_', custom: {_CUSTOM_}});";
      script = StringUtils.replace(script, "_TYPE_", typeId);
      script = StringUtils.replace(script, "_ID_", id);
      script = StringUtils.replace(script, "_LABEL_", view.getFullLabel());
      script = StringUtils.replace(script, "_ICON_", deriveIconClass(view.getIcon()));
      script = StringUtils.replace(script, "_URL_", url);
      script = StringUtils.replace(script, "_CUSTOM_", view.getParamsAsJson());

      addEventScript(script);
   }

   /**
    * @param iconUrl
    * @return
    */
   public static String deriveIconClass(String iconUrl)
   {
      String icon = "";
      if (StringUtils.isNotEmpty(iconUrl))
      {
         int slashIndex = iconUrl.lastIndexOf("/");
         if (slashIndex > -1)
         {
            icon = iconUrl.substring(slashIndex+1, iconUrl.lastIndexOf("."));
         }
      }
      return icon;
   }

   /**
    * 
    * @param view
    */
   public void updateViewIconClass(View view)
   {
      String iconClass = deriveIconClass(view.getIcon());

      String popupScript;
      String html5FWViewId = (String)view.getViewParams().get("html5FWViewId");
      if (StringUtils.isNotEmpty(html5FWViewId))
      {
         popupScript = "parent.BridgeUtils.View.setIcon('" + iconClass + "', '" + html5FWViewId + "');";
      }
      else
      {
         popupScript = "parent.BridgeUtils.View.setIcon('" + iconClass + "');";
      }
      addEventScript(popupScript);
   }

   /**
    * 
    * @param view
    */
   public void updateViewTitle(View view)
   {
      String title = view.getFullLabel();

      String popupScript;
      String html5FWViewId = (String)view.getViewParams().get("html5FWViewId");
      if (StringUtils.isNotEmpty(html5FWViewId))
      {
         popupScript = "parent.BridgeUtils.View.setTitle('" + title + "', '" + html5FWViewId + "');";
      }
      else
      {
         popupScript = "parent.BridgeUtils.View.setTitle('" + title + "');";   
      }
      
      addEventScript(popupScript);
   }
   
   /**
    * @param view
    */
   private void handleViewClosePanama(View view)
   {
      String html5FWViewId = (String)view.getViewParams().get("html5FWViewId");
      if (StringUtils.isNotEmpty(html5FWViewId))
      {
         String script = "parent.BridgeUtils.View.closeView('" + html5FWViewId + "');";
         addEventScript(script);
      }
   }

   /**
    * @param str
    * @return
    */
   private String encodeUrl(String str)
   {
      if (str != null)
      {
         try
         {
            return URLEncoder.encode(str, "UTF-8");
         }
         catch (UnsupportedEncodingException e)
         {
         }
      }

      return str;
   }

   public int getViewIndex(View view)
   {
      return displayedViews.indexOf(view);
   }

   /**
    * @param view
    * @param justOpened
    */
   private void addToDisplayedViews(View view, boolean justOpened)
   {
      addToDisplayedViews(view, justOpened, -1);
   }

   /**
    * @param view
    */
   private void addToDisplayedViews(View view)
   {
      addToDisplayedViews(view, false);
   }

   /**
    * @param view
    */
   private void firePostOpenLifeCycleEvent(View view)
   {
      portalUiController.broadcastNonVetoableViewEvent(view, ViewEventType.POST_OPEN_LIFECYCLE);
   }

   /**
    * Build Overflow View List
    */
   private void buildOverflowViews()
   {
      overflowedViews = new ArrayList<View>();
      for (View openView : getOpenViews())
      {
         if(!displayedViews.contains(openView))
            overflowedViews.add(openView);
      }
   }

   /**
    *
    */
   public void refreshSkin()
   {
      try
      {
         // Load The selected Theme from Preferences
         UserPreferencesHelper userPrefsHelper = UserPreferencesHelper.getInstance(M_PORTAL);
         UIController.getInstance().getThemeProvider().loadTheme(userPrefsHelper.getSingleString(V_PORTAL_CONFIG, F_SKIN));
         skinFiles = UIController.getInstance().getThemeProvider().getStyleSheets();
      }
      catch(Exception e)
      {
         MessageDialog.addErrorMessage(MessagePropertiesBean.getInstance().getString("common.unknownError"), e);
      }
   }

   /**
    *
    */
   private void loadPerspective()
   {
      UserPreferencesHelper userPrefsHelper = UserPreferencesHelper.getInstance(M_PORTAL);
      String perspectiveId = userPrefsHelper.getSingleString(V_PORTAL_CONFIG, F_DEFAULT_PERSPECTIVE);
      if (StringUtils.isNotEmpty(perspectiveId))
      {
         if (!getPortalUiController().loadPerspective(perspectiveId))
         {
            trace.warn("Cannot load default Perspective, either it's not available or user is not authorized - "
                  + perspectiveId);
         }
      }
   }

   public boolean isExternalAuthentication()
   {
      return userProvider.isExternalAuthentication();
   }

   public boolean isExternalAuthorization()
   {
      return userProvider.isExternalAuthorization();
   }

   /**
    *
    */
   private void retrieveRuntimeEnvInfo()
   {
      version = "";
      copyrightMessage = "";

      if (null != runtimeEnvironmentInfoProvider)
      {
         try
         {
            version = runtimeEnvironmentInfoProvider.getVersion().getCompleteString();
         }
         catch (Exception e)
         {
            trace.error("Could not retrieve Version Information", e);
         }

         try
         {
            copyrightMessage = runtimeEnvironmentInfoProvider.getCopyrightInfo().getMessage();
         }
         catch (Exception e)
         {
            trace.error("Could not retrieve Copyright Information", e);
         }
      }
   }

   /**
    * @return
    */
   public String getOverflowTabIframePopupId()
   {
      return  "'OverflowiFrame'";
   }

   /**
    * @return
    */
   public String getOverflowTabIframePopupArgs()
   {
      String advanceArgs = "{anchorId:'ippOverflowTabAnchor', width:100, height:30, maxWidth:800, maxHeight:550, "
            + "openOnRight:false, anchorXAdjustment:120, anchorYAdjustment:5, zIndex:200, border:'1px solid black', noUnloadWarning: 'true'}";
      return advanceArgs;
   }


   /**
    * @param view
    * @param handler
    */
   public void registerViewDataEventHandler(View view, ViewDataEventHandler handler)
   {
      getPortalUiController().registerViewDataEventHandler(view, handler);
   }

   /**
    * @param view
    * @param handler
    */
   public void unregisterViewDataEventHandler(View view, ViewDataEventHandler handler)
   {
      getPortalUiController().unregisterViewDataEventHandler(view, handler);
   }

   /**
    * @param event
    */
   public void broadcastViewDataEvent(ViewDataEvent event)
   {
      getPortalUiController().broadcastViewDataEvent(event);
   }

   /**
    *
    */
   private void addDummyOverflowView()
   {
      showOverflowTabs = false;
      if(getOpenViewsSize() > displayedViews.size())
      {
         displayedViews.add(dummyViewForOverflowTab);
         showOverflowTabs = true;
      }
   }

   /**
    * @param closedView
    * @param focusView
    * @param forceClose
    */
   private void handleViewClose(View closedView, View focusView, boolean forceClose)
   {
      resetWindowWidth();
      // Closing current View trigger's call to setFocusView(nextOpenView), which will
      // try to open next child views, closing child views first will setFocusView(null)
      // as child views will be already closed
      closeChildViews(closedView, forceClose);
      removeFromDisplayedViews(closedView);

      if(focusView == closedView)
         setFocusView(getLastFocusView());
      else
         setFocusView(getFocusView()); // This is required because the index of focus view would have changed

      if(getOpenViewsSize() == 0) // If this is the last view closed, activate launch Panels
      {
         launchPanelsActivated = true;
         fullScreenModeActivated = false;
         restorePinView();
      }

      handleViewClosePanama(closedView);
      //handleViewOpenPanama(focusView);

   }

   /**
    * @param view
    * @param forceClose
    */
   private void closeChildViews(View view, boolean forceClose)
   {
      ViewDefinition viewDefinition = view.getDefinition();
      if (viewDefinition != null) // Better to be safe!
      {
         String closingPolicy = viewDefinition.getClosingPolicy();

         if (ViewDefinition.CLOSING_POLICY_DIRECT.equalsIgnoreCase(closingPolicy)
               || ViewDefinition.CLOSING_POLICY_RECURSIVE.equalsIgnoreCase(closingPolicy))
         {
            boolean recursive = ViewDefinition.CLOSING_POLICY_RECURSIVE.equalsIgnoreCase(closingPolicy) ? true : false;
            List<View> childViews = getPortalUiController().getChildViews(view, recursive);
            for (View childView : childViews)
            {
               if (ViewState.CLOSED != childView.getViewState()) // Safety Check
               {
                  if (trace.isDebugEnabled())
                  {
                     trace.debug("Cascade Closing Child View -> " + childView);
                  }
                  closeView(childView, forceClose);
               }
            }
         }
      }
   }

   /**
    * @param view
    */
   private void removeFromDisplayedViews(View view)
   {
      if(displayedViews.contains(view))
      {
         displayedViews.remove(dummyViewForOverflowTab);
         displayedViews.remove(view);

         for (View openView : getOpenViews())
         {
            if(!displayedViews.contains(openView))
            {
               displayedViews.add(openView);
               break;
            }
         }

         buildOverflowViews();
         addDummyOverflowView();
      }
      else if(view == pinView)
      {
         pinViewOpened = false;
         pinView = null;
         launchPanelsActivated = true;
      }

      removeFromFocusViewStack(view);
   }

   /**
    * @param view
    */
   private void addToFocusViewStack(View view)
   {
      if(focusViewStack.contains(view))
         focusViewStack.remove(view);
      focusViewStack.add(view);
   }

   /**
    * @param view
    */
   private void removeFromFocusViewStack(View view)
   {
      if(focusViewStack.contains(view))
         focusViewStack.remove(view);
   }

   /**
    * @return
    */
   private View getLastFocusView()
   {
      if (trace.isDebugEnabled())
      {
         trace.debug("focusViewStack = " + focusViewStack);
      }
      if(focusViewStack.size() > 0)
         return focusViewStack.get(focusViewStack.size() - 1);
      return null;
   }

   /**
    * @return
    */
   public String getLocale()
   {
      return MessagePropertiesBean.getInstance().getLocale();
   }

   /**
    * @return
    */
   public Locale getLocaleObject()
   {
      return MessagePropertiesBean.getInstance().getLocaleObject();
   }

   /**
    * @return
    */
   public TimeZone getTimeZone()
   {
      if (clientTimeZone != null)
      {
         return clientTimeZone;
      }
      else
      {
         return java.util.TimeZone.getDefault();
      }
   }

   public boolean isClientTimeZoneSet()
   {
      //Following fix was added as part of CRNT-20962 but later on with the new Icefaces jars the issue got resolved
      //Keeping the following code as comment it may required in future
      /*         String userAgent = FacesUtils.getUserAgent();
      try
      {
         String userAgent = FacesUtils.getUserAgent();

         if (null == userAgent || userAgent.toLowerCase().contains("chrome"))
         {
            clientTimeZone = java.util.TimeZone.getDefault();
            trace.error("Browser type 'Chrome' detected or could not get User-Agent. UserAgent = " + userAgent);
            trace.error("Not supporting client timezone. Server Time will be referred.");
         }
      }
      catch (Exception e)
      {
         clientTimeZone = java.util.TimeZone.getDefault();
         trace.error("Not supporting client timezone. Server Time will be referred", e);
      }*/
      return clientTimeZone != null;
   }

   /**
    * @param view
    * @param newViewKey
    */
   public void updateViewKey(View view, String newViewKey)
   {
      getPortalUiController().updateViewKey(view, newViewKey);
   }

   private void setDisplayMode(int displayMode)
   {
      this.displayMode = displayMode;
   }

   public boolean isTabDisplayMode()
   {
      return getDisplayMode() == TAB_DISPLAY_MODE;
   }

   public void setTabDisplayMode()
   {
      setDisplayMode(TAB_DISPLAY_MODE);
   }

   public boolean isGridDisplayMode()
   {
      return getDisplayMode() == GRID_DISPLAY_MODE;
   }

   public void setGridDisplayMode()
   {
      setDisplayMode(GRID_DISPLAY_MODE);
   }

   public boolean isHorizontalSplitDisplayMode()
   {
      return getDisplayMode() == HORIZONTAL_SPLIT_DISPLAY_MODE;
   }

   public void setHorizontalSplitDisplayMode()
   {
      setDisplayMode(HORIZONTAL_SPLIT_DISPLAY_MODE);
   }

   public boolean isVerticalSplitDisplayMode()
   {
      return getDisplayMode() == VERTICAL_SPLIT_DISPLAY_MODE;
   }

   public void setVerticalSplitDisplayMode()
   {
      setDisplayMode(VERTICAL_SPLIT_DISPLAY_MODE);
   }

   private int getDisplayMode()
   {
      return displayMode;
   }

   public PortalUiController getPortalUiController()
   {
      return portalUiController;
   }

   /**
    * @deprecated Use portalUiController directly
    */
   @Deprecated
   public PerspectiveController getPerspectiveController()
   {
      return portalUiController.getPerspectiveController();
   }

   public void setPortalUiController(PortalUiController portalUiController)
   {
      this.portalUiController = portalUiController;
   }

   public List<View> getActiveViewBreadCrumb()
   {
      return activeViewBreadCrumb;
   }

   public List<View> getDisplayedViews()
   {
      return displayedViews;
   }

   public List<View> getOverflowedViews()
   {
      return overflowedViews;
   }

   public boolean isShowOverflowTabs()
   {
      return showOverflowTabs;
   }

   public boolean isPinViewOpened()
   {
      return pinViewOpened;
   }

   public void setPinViewOpened(boolean pinViewOpened)
   {
      this.pinViewOpened = pinViewOpened;
   }

   public String getPinViewOrientation()
   {
      return pinViewOrientation;
   }

   public View getPinView()
   {
      return pinView;
   }

   public List<String> getSkinFiles()
   {
      return skinFiles;
   }

   public View getActiveView()
   {
      return activeView;
   }

   public void setUserProvider(UserProvider userProvider)
   {
      this.userProvider = userProvider;
   }

   /**
    * @return
    */
   public String getEventScripts()
   {
      return portalApplicationEventScript.getEventScripts();
   }

   /**
    * @param eventScript
    */
   public void addEventScript(String eventScript)
   {
      portalApplicationEventScript.addEventScript(eventScript);
   }

   /**
    * Called by Phase Listener
    */
   public void cleanEventScripts()
   {
      portalApplicationEventScript.cleanEventScripts();
   }

   public PortalApplicationEventScript getPortalApplicationEventScript()
   {
      return portalApplicationEventScript;
   }

   public void setPortalApplicationEventScript(PortalApplicationEventScript portalApplicationEventScript)
   {
      this.portalApplicationEventScript = portalApplicationEventScript;
   }

   /**
    * @param event
    */
   public void timeZoneChangeListener(ValueChangeEvent event)
   {
      try
      {
         clientTimeZone = DateUtils.getClientTimeZone(event.getNewValue());
      }
      catch (Exception e)
      {
         clientTimeZone = java.util.TimeZone.getDefault();
         trace.error("Not supporting client timezone. Server Time will be referred", e);
      }
   }

   /**
    * New value would be a Json Object, with following Info
    *   type: String
    *   data: Object
    *
    * @param event
    */
   public void messageReceived(ValueChangeEvent event)
   {
      trace.debug("Received Message: " + event.getNewValue());
      postMessage((String)event.getNewValue());
   }

   /**
    * Called from XHTML action
    */
   @SuppressWarnings("unchecked")
   public void postMessage()
   {
      FacesContext context = FacesContext.getCurrentInstance();
      Map<String, String> params = context.getExternalContext().getRequestParameterMap();
      String jsonMessage = (String) params.get("message");
      postMessage(jsonMessage);
   }

   /**
    * This is a utility method, to be called from Java Classes
    * @param jsonMessage Stringified Json
    */
   public void postMessage(String jsonMessage)
   {
      try
      {
         MessageProcessor.processs(jsonMessage);
      }
      catch (Exception e)
      {
         MessageDialog.addErrorMessage(
               MessagePropertiesBean.getInstance().getString("portalFramework.error.messageProcessError"), e);
      }
   }

   public String getMessageBlank()
   {
      return "empty";
   }

   public void setMessageBlank(String message)
   {
      // Nop;
   }

   public void setRuntimeEnvironmentInfoProvider(RuntimeEnvironmentInfoProvider runtimeEnvironmentInfoProvider)
   {
      this.runtimeEnvironmentInfoProvider = runtimeEnvironmentInfoProvider;
   }

   public String getVersion()
   {
      return version;
   }

   public String getCopyrightMessage()
   {
      return copyrightMessage;
   }

   public String getLogoutUri()
   {
      return logoutUri;
   }

   public int getMaxTabDisplay()
   {
      if (maxTabDisplay == -1)
      {
         try
         {
            maxTabDisplay = UserPreferencesHelper.getInstance(M_PORTAL).getInteger(V_PORTAL_CONFIG,
                  F_TABS_MAX_TABS_DISPLAY, DEFAULT_MAX_TAB_DISPLAY);
         }
         catch (Exception e)
         {
            maxTabDisplay = DEFAULT_MAX_TAB_DISPLAY;
            trace.error("Exception occurred while reading user preferences (maxTabDisplay), Using default as "
                  + DEFAULT_MAX_TAB_DISPLAY, e);
         }
      }

      return maxTabDisplay;
   }

   public String getLocaleString()
   {
      return getLocaleObject().toString();
   }
}