1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.theme;
16  
17  import com.liferay.portal.kernel.log.Log;
18  import com.liferay.portal.kernel.log.LogFactoryUtil;
19  import com.liferay.portal.kernel.util.HtmlUtil;
20  import com.liferay.portal.kernel.util.StringPool;
21  import com.liferay.portal.kernel.util.Validator;
22  
23  import java.io.Serializable;
24  
25  import javax.portlet.PortletPreferences;
26  
27  /**
28   * <a href="PortletDisplay.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Brian Wing Shun Chan
31   * @author Eduardo Lundgren
32   */
33  public class PortletDisplay implements Serializable {
34  
35      public PortletDisplay() {
36          if (_log.isDebugEnabled()) {
37              _log.debug("Creating new instance " + hashCode());
38          }
39      }
40  
41      public ThemeDisplay getThemeDisplay() {
42          return _themeDisplay;
43      }
44  
45      public void setThemeDisplay(ThemeDisplay themeDisplay) {
46          _themeDisplay = themeDisplay;
47      }
48  
49      public String getId() {
50          return _id;
51      }
52  
53      public void setId(String id) {
54          _id = id;
55      }
56  
57      public String getRootPortletId() {
58          return _rootPortletId;
59      }
60  
61      public void setRootPortletId(String rootPortletId) {
62          _rootPortletId = rootPortletId;
63      }
64  
65      public String getInstanceId() {
66          return _instanceId;
67      }
68  
69      public void setInstanceId(String instanceId) {
70          _instanceId = instanceId;
71      }
72  
73      public String getResourcePK() {
74          return _resourcePK;
75      }
76  
77      public void setResourcePK(String resourcePK) {
78          _resourcePK = resourcePK;
79      }
80  
81      public String getPortletName() {
82          return _portletName;
83      }
84  
85      public void setPortletName(String portletName) {
86          _portletName = portletName;
87      }
88  
89      public String getNamespace() {
90          return _namespace;
91      }
92  
93      public void setNamespace(String namespace) {
94          _namespace = namespace;
95      }
96  
97      public String getTitle() {
98          return _title;
99      }
100 
101     public void setTitle(String title) {
102         title = HtmlUtil.escape(title);
103 
104         _title = title;
105 
106         // LEP-5317
107 
108         if (Validator.isNull(_id)) {
109             setId(_themeDisplay.getTilesTitle());
110         }
111     }
112 
113     public String getDescription() {
114         return _description;
115     }
116 
117     public void setDescription(String description) {
118         description = HtmlUtil.escape(description);
119 
120         _description = description;
121     }
122 
123     public String getCustomCSSClassName() {
124         return _customCSSClassName;
125     }
126 
127     public void setCustomCSSClassName(String customCSSClassName) {
128         _customCSSClassName = customCSSClassName;
129     }
130 
131     public boolean isAccess() {
132         return _access;
133     }
134 
135     public void setAccess(boolean access) {
136         _access = access;
137     }
138 
139     public boolean isActive() {
140         return _active;
141     }
142 
143     public void setActive(boolean active) {
144         _active = active;
145     }
146 
147     public String getColumnId() {
148         return _columnId;
149     }
150 
151     public void setColumnId(String columnId) {
152         _columnId = columnId;
153     }
154 
155     public int getColumnPos() {
156         return _columnPos;
157     }
158 
159     public void setColumnPos(int columnPos) {
160         _columnPos = columnPos;
161     }
162 
163     public int getColumnCount() {
164         return _columnCount;
165     }
166 
167     public void setColumnCount(int columnCount) {
168         _columnCount = columnCount;
169     }
170 
171     public boolean isStateExclusive() {
172         return _stateExclusive;
173     }
174 
175     public void setStateExclusive(boolean stateExclusive) {
176         _stateExclusive = stateExclusive;
177     }
178 
179     public boolean isStateMax() {
180         return _stateMax;
181     }
182 
183     public void setStateMax(boolean stateMax) {
184         _stateMax = stateMax;
185     }
186 
187     public boolean isStateMin() {
188         return _stateMin;
189     }
190 
191     public void setStateMin(boolean stateMin) {
192         _stateMin = stateMin;
193     }
194 
195     public boolean isStateNormal() {
196         return _stateNormal;
197     }
198 
199     public void setStateNormal(boolean stateNormal) {
200         _stateNormal = stateNormal;
201     }
202 
203     public boolean isStatePopUp() {
204         return _statePopUp;
205     }
206 
207     public void setStatePopUp(boolean statePopUp) {
208         _statePopUp = statePopUp;
209     }
210 
211     public boolean isModeAbout() {
212         return _modeAbout;
213     }
214 
215     public void setModeAbout(boolean modeAbout) {
216         _modeAbout = modeAbout;
217     }
218 
219     public boolean isModeConfig() {
220         return _modeConfig;
221     }
222 
223     public void setModeConfig(boolean modeConfig) {
224         _modeConfig = modeConfig;
225     }
226 
227     public boolean isModeEdit() {
228         return _modeEdit;
229     }
230 
231     public void setModeEdit(boolean modeEdit) {
232         _modeEdit = modeEdit;
233     }
234 
235     public boolean isModeEditDefaults() {
236         return _modeEditDefaults;
237     }
238 
239     public void setModeEditDefaults(boolean modeEditDefaults) {
240         _modeEditDefaults = modeEditDefaults;
241     }
242 
243     public boolean isModeEditGuest() {
244         return _modeEditGuest;
245     }
246 
247     public void setModeEditGuest(boolean modeEditGuest) {
248         _modeEditGuest = modeEditGuest;
249     }
250 
251     public boolean isModeHelp() {
252         return _modeHelp;
253     }
254 
255     public void setModeHelp(boolean modeHelp) {
256         _modeHelp = modeHelp;
257     }
258 
259     public boolean isModePreview() {
260         return _modePreview;
261     }
262 
263     public void setModePreview(boolean modePreview) {
264         _modePreview = modePreview;
265     }
266 
267     public boolean isModePrint() {
268         return _modePrint;
269     }
270 
271     public void setModePrint(boolean modePrint) {
272         _modePrint = modePrint;
273     }
274 
275     public boolean isShowBackIcon() {
276         return _showBackIcon;
277     }
278 
279     public void setShowBackIcon(boolean showBackIcon) {
280         _showBackIcon = showBackIcon;
281     }
282 
283     public boolean isShowCloseIcon() {
284         return _showCloseIcon;
285     }
286 
287     public void setShowCloseIcon(boolean showCloseIcon) {
288         _showCloseIcon = showCloseIcon;
289     }
290 
291     public boolean isShowConfigurationIcon() {
292         return _showConfigurationIcon;
293     }
294 
295     public void setShowConfigurationIcon(boolean showConfigurationIcon) {
296         _showConfigurationIcon = showConfigurationIcon;
297     }
298 
299     public boolean isShowEditIcon() {
300         return _showEditIcon;
301     }
302 
303     public void setShowEditIcon(boolean showEditIcon) {
304         _showEditIcon = showEditIcon;
305     }
306 
307     public boolean isShowEditDefaultsIcon() {
308         return _showEditDefaultsIcon;
309     }
310 
311     public void setShowEditDefaultsIcon(boolean showEditDefaultsIcon) {
312         _showEditDefaultsIcon = showEditDefaultsIcon;
313     }
314 
315     public boolean isShowEditGuestIcon() {
316         return _showEditGuestIcon;
317     }
318 
319     public void setShowEditGuestIcon(boolean showEditGuestIcon) {
320         _showEditGuestIcon = showEditGuestIcon;
321     }
322 
323     public boolean isShowExportImportIcon() {
324         return _showExportImportIcon;
325     }
326 
327     public void setShowExportImportIcon(boolean showExportImportIcon) {
328         _showExportImportIcon = showExportImportIcon;
329     }
330 
331     public boolean isShowHelpIcon() {
332         return _showHelpIcon;
333     }
334 
335     public void setShowHelpIcon(boolean showHelpIcon) {
336         _showHelpIcon = showHelpIcon;
337     }
338 
339     public boolean isShowMaxIcon() {
340         return _showMaxIcon;
341     }
342 
343     public void setShowMaxIcon(boolean showMaxIcon) {
344         _showMaxIcon = showMaxIcon;
345     }
346 
347     public boolean isShowMinIcon() {
348         return _showMinIcon;
349     }
350 
351     public void setShowMinIcon(boolean showMinIcon) {
352         _showMinIcon = showMinIcon;
353     }
354 
355     public boolean isShowMoveIcon() {
356         return _showMoveIcon;
357     }
358 
359     public void setShowMoveIcon(boolean showMoveIcon) {
360         _showMoveIcon = showMoveIcon;
361     }
362 
363     public boolean isShowPortletCssIcon() {
364         return _showPortletCssIcon;
365     }
366 
367     public void setShowPortletCssIcon(boolean showPortletCssIcon) {
368         _showPortletCssIcon = showPortletCssIcon;
369     }
370 
371     public boolean isShowPortletIcon() {
372         return _showPortletIcon;
373     }
374 
375     public void setShowPortletIcon(boolean showPortletIcon) {
376         _showPortletIcon = showPortletIcon;
377     }
378 
379     public boolean isShowPrintIcon() {
380         return _showPrintIcon;
381     }
382 
383     public void setShowPrintIcon(boolean showPrintIcon) {
384         _showPrintIcon = showPrintIcon;
385     }
386 
387     public boolean isShowRefreshIcon() {
388         return _showRefreshIcon;
389     }
390 
391     public void setShowRefreshIcon(boolean showRefreshIcon) {
392         _showRefreshIcon = showRefreshIcon;
393     }
394 
395     public String getURLBack() {
396         return _urlBack;
397     }
398 
399     public void setURLBack(String urlBack) {
400         _urlBack = urlBack;
401     }
402 
403     public String getURLClose() {
404         return _urlClose;
405     }
406 
407     public void setURLClose(String urlClose) {
408         _urlClose = urlClose;
409     }
410 
411     public String getURLConfiguration() {
412         return _urlConfiguration;
413     }
414 
415     public void setURLConfiguration(String urlConfiguration) {
416         _urlConfiguration = urlConfiguration;
417     }
418 
419     public String getURLEdit() {
420         return _urlEdit;
421     }
422 
423     public void setURLEdit(String urlEdit) {
424         _urlEdit = urlEdit;
425     }
426 
427     public String getURLEditDefaults() {
428         return _urlEditDefaults;
429     }
430 
431     public void setURLEditDefaults(String urlEditDefaults) {
432         _urlEditDefaults = urlEditDefaults;
433     }
434 
435     public String getURLEditGuest() {
436         return _urlEditGuest;
437     }
438 
439     public void setURLEditGuest(String urlEditGuest) {
440         _urlEditGuest = urlEditGuest;
441     }
442 
443     public String getURLExportImport() {
444         return _urlExportImport;
445     }
446 
447     public void setURLExportImport(String urlExportImport) {
448         _urlExportImport = urlExportImport;
449     }
450 
451     public String getURLHelp() {
452         return _urlHelp;
453     }
454 
455     public void setURLHelp(String urlHelp) {
456         _urlHelp = urlHelp;
457     }
458 
459     public String getURLMax() {
460         return _urlMax;
461     }
462 
463     public void setURLMax(String urlMax) {
464         _urlMax = urlMax;
465     }
466 
467     public String getURLMin() {
468         return _urlMin;
469     }
470 
471     public void setURLMin(String urlMin) {
472         _urlMin = urlMin;
473     }
474 
475     public String getURLPortlet() {
476         return _urlPortlet;
477     }
478 
479     public void setURLPortlet(String urlPortlet) {
480         _urlPortlet = urlPortlet;
481     }
482 
483     public String getURLPortletCss() {
484         return _urlPortletCss;
485     }
486 
487     public void setURLPortletCss(String urlPortletCss) {
488         _urlPortletCss = urlPortletCss;
489     }
490 
491     public String getURLPrint() {
492         return _urlPrint;
493     }
494 
495     public void setURLPrint(String urlPrint) {
496         _urlPrint = urlPrint;
497     }
498 
499     public String getURLRefresh() {
500         return _urlRefresh;
501     }
502 
503     public void setURLRefresh(String urlRefresh) {
504         _urlRefresh = urlRefresh;
505     }
506 
507     public boolean isWebDAVEnabled() {
508         return _webDAVEnabled;
509     }
510 
511     public void setWebDAVEnabled(boolean webDAVEnabled) {
512         _webDAVEnabled = webDAVEnabled;
513     }
514 
515     public boolean isRestoreCurrentView() {
516         return _restoreCurrentView;
517     }
518 
519     public void setRestoreCurrentView(boolean restoreCurrentView) {
520         _restoreCurrentView = restoreCurrentView;
521     }
522 
523     public String getContent() {
524         return _content;
525     }
526 
527     public void setContent(String content) {
528         _content = content;
529     }
530 
531     public PortletPreferences getPortletSetup() {
532         return _portletSetup;
533     }
534 
535     public void setPortletSetup(PortletPreferences portletSetup) {
536         _portletSetup = portletSetup;
537     }
538 
539     public void recycle() {
540         if (_log.isDebugEnabled()) {
541             _log.debug("Recycling instance " + hashCode());
542         }
543 
544         _id = StringPool.BLANK;
545         _rootPortletId = StringPool.BLANK;
546         _instanceId = StringPool.BLANK;
547         _resourcePK = StringPool.BLANK;
548         _portletName = StringPool.BLANK;
549         _namespace = StringPool.BLANK;
550         _title = StringPool.BLANK;
551         _description = StringPool.BLANK;
552         _customCSSClassName = StringPool.BLANK;
553         _access = false;
554         _active = false;
555         _columnId = StringPool.BLANK;
556         _stateExclusive = false;
557         _stateMax = false;
558         _stateMin = false;
559         _stateNormal = false;
560         _statePopUp = false;
561         _modeAbout = false;
562         _modeConfig = false;
563         _modeEdit = false;
564         _modeEditDefaults = false;
565         _modeEditGuest = false;
566         _modeHelp = false;
567         _modePreview = false;
568         _modePrint = false;
569         _showBackIcon = false;
570         _showCloseIcon = false;
571         _showConfigurationIcon = false;
572         _showEditIcon = false;
573         _showEditDefaultsIcon = false;
574         _showEditGuestIcon = false;
575         _showHelpIcon = false;
576         _showMaxIcon = false;
577         _showMinIcon = false;
578         _showMoveIcon = false;
579         _showPortletCssIcon = false;
580         _showPortletIcon = false;
581         _showPrintIcon = false;
582         _showRefreshIcon = false;
583         _urlBack = StringPool.BLANK;
584         _urlClose = StringPool.BLANK;
585         _urlConfiguration = StringPool.BLANK;
586         _urlEdit = StringPool.BLANK;
587         _urlEditDefaults = StringPool.BLANK;
588         _urlEditGuest = StringPool.BLANK;
589         _urlExportImport = StringPool.BLANK;
590         _urlHelp = StringPool.BLANK;
591         _urlMax = StringPool.BLANK;
592         _urlMin = StringPool.BLANK;
593         _urlPortlet = StringPool.BLANK;
594         _urlPortletCss = StringPool.BLANK;
595         _urlPrint = StringPool.BLANK;
596         _urlRefresh = StringPool.BLANK;
597         _webDAVEnabled = false;
598         _restoreCurrentView = false;
599         _content = StringPool.BLANK;
600         _portletSetup = null;
601     }
602 
603     public void copyFrom(PortletDisplay master) {
604         _themeDisplay = master.getThemeDisplay();
605         _id = master.getId();
606         _rootPortletId = master.getRootPortletId();
607         _instanceId = master.getInstanceId();
608         _resourcePK = master.getResourcePK();
609         _portletName = master.getPortletName();
610         _namespace = master.getNamespace();
611         _title = master.getTitle();
612         _description = master.getDescription();
613         _customCSSClassName = master.getCustomCSSClassName();
614         _access = master.isAccess();
615         _active = master.isActive();
616         _columnId = master.getColumnId();
617         _stateExclusive = master.isStateExclusive();
618         _stateMax = master.isStateMax();
619         _stateMin = master.isStateMin();
620         _stateNormal = master.isStateNormal();
621         _statePopUp = master.isStatePopUp();
622         _modeAbout = master.isModeAbout();
623         _modeConfig = master.isModeConfig();
624         _modeEdit = master.isModeEdit();
625         _modeEditDefaults = master.isModeEditDefaults();
626         _modeEditGuest = master.isModeEditGuest();
627         _modeHelp = master.isModeHelp();
628         _modePreview = master.isModePreview();
629         _modePrint = master.isModePrint();
630         _showBackIcon = master.isShowBackIcon();
631         _showCloseIcon = master.isShowCloseIcon();
632         _showConfigurationIcon = master.isShowConfigurationIcon();
633         _showEditIcon = master.isShowEditIcon();
634         _showEditDefaultsIcon = master.isShowEditDefaultsIcon();
635         _showEditGuestIcon = master.isShowEditGuestIcon();
636         _showHelpIcon = master.isShowHelpIcon();
637         _showMaxIcon = master.isShowMaxIcon();
638         _showMinIcon = master.isShowMinIcon();
639         _showMoveIcon = master.isShowMoveIcon();
640         _showPortletCssIcon = master.isShowPortletCssIcon();
641         _showPortletIcon = master.isShowPortletIcon();
642         _showPrintIcon = master.isShowPrintIcon();
643         _showRefreshIcon = master.isShowRefreshIcon();
644         _urlBack = master.getURLBack();
645         _urlClose = master.getURLClose();
646         _urlConfiguration = master.getURLConfiguration();
647         _urlEdit = master.getURLEdit();
648         _urlEditDefaults = master.getURLEditDefaults();
649         _urlExportImport = master.getURLExportImport();
650         _urlHelp = master.getURLHelp();
651         _urlMax = master.getURLMax();
652         _urlMin = master.getURLMin();
653         _urlPortlet = master.getURLPortlet();
654         _urlPortletCss = master.getURLPortletCss();
655         _urlPrint = master.getURLPrint();
656         _urlRefresh = master.getURLRefresh();
657         _webDAVEnabled = master.isWebDAVEnabled();
658         _restoreCurrentView = master.isRestoreCurrentView();
659         _content = master.getContent();
660         _portletSetup = master.getPortletSetup();
661     }
662 
663     public void copyTo(PortletDisplay slave) {
664         slave.setThemeDisplay(_themeDisplay);
665         slave.setId(_id);
666         slave.setRootPortletId(_rootPortletId);
667         slave.setInstanceId(_instanceId);
668         slave.setResourcePK(_resourcePK);
669         slave.setPortletName(_portletName);
670         slave.setNamespace(_namespace);
671         slave.setTitle(_title);
672         slave.setDescription(_description);
673         slave.setCustomCSSClassName(_customCSSClassName);
674         slave.setAccess(_access);
675         slave.setActive(_active);
676         slave.setColumnId(_columnId);
677         slave.setStateExclusive(_stateExclusive);
678         slave.setStateMax(_stateMax);
679         slave.setStateMin(_stateMin);
680         slave.setStateNormal(_stateNormal);
681         slave.setStatePopUp(_statePopUp);
682         slave.setModeAbout(_modeAbout);
683         slave.setModeConfig(_modeConfig);
684         slave.setModeEdit(_modeEdit);
685         slave.setModeEditDefaults(_modeEditDefaults);
686         slave.setModeEditGuest(_modeEditGuest);
687         slave.setModeHelp(_modeHelp);
688         slave.setModePreview(_modePreview);
689         slave.setModePrint(_modePrint);
690         slave.setShowBackIcon(_showBackIcon);
691         slave.setShowCloseIcon(_showCloseIcon);
692         slave.setShowConfigurationIcon(_showConfigurationIcon);
693         slave.setShowEditIcon(_showEditIcon);
694         slave.setShowEditDefaultsIcon(_showEditDefaultsIcon);
695         slave.setShowEditGuestIcon(_showEditGuestIcon);
696         slave.setShowHelpIcon(_showHelpIcon);
697         slave.setShowMaxIcon(_showMaxIcon);
698         slave.setShowMinIcon(_showMinIcon);
699         slave.setShowMoveIcon(_showMoveIcon);
700         slave.setShowPortletCssIcon(_showPortletCssIcon);
701         slave.setShowPortletIcon(_showPortletIcon);
702         slave.setShowPrintIcon(_showPrintIcon);
703         slave.setShowRefreshIcon(_showRefreshIcon);
704         slave.setURLBack(_urlBack);
705         slave.setURLClose(_urlClose);
706         slave.setURLConfiguration(_urlConfiguration);
707         slave.setURLEdit(_urlEdit);
708         slave.setURLEditDefaults(_urlEditDefaults);
709         slave.setURLEditGuest(_urlEditGuest);
710         slave.setURLExportImport(_urlExportImport);
711         slave.setURLHelp(_urlHelp);
712         slave.setURLMax(_urlMax);
713         slave.setURLMin(_urlMin);
714         slave.setURLPortlet(_urlPortlet);
715         slave.setURLPortletCss(_urlPortletCss);
716         slave.setURLPrint(_urlPrint);
717         slave.setURLRefresh(_urlRefresh);
718         slave.setWebDAVEnabled(_webDAVEnabled);
719         slave.setRestoreCurrentView(_restoreCurrentView);
720         slave.setContent(_content);
721         slave.setPortletSetup(_portletSetup);
722     }
723 
724     private static Log _log = LogFactoryUtil.getLog(PortletDisplay.class);
725 
726     private ThemeDisplay _themeDisplay;
727     private String _id = StringPool.BLANK;
728     private String _rootPortletId = StringPool.BLANK;
729     private String _instanceId = StringPool.BLANK;
730     private String _resourcePK = StringPool.BLANK;
731     private String _portletName = StringPool.BLANK;
732     private String _namespace = StringPool.BLANK;
733     private String _title = StringPool.BLANK;
734     private String _description = StringPool.BLANK;
735     private String _customCSSClassName = StringPool.BLANK;
736     private boolean _access;
737     private boolean _active;
738     private String _columnId = StringPool.BLANK;
739     private int _columnPos;
740     private int _columnCount;
741     private boolean _stateExclusive;
742     private boolean _stateMax;
743     private boolean _stateMin;
744     private boolean _stateNormal;
745     private boolean _statePopUp;
746     private boolean _modeAbout;
747     private boolean _modeConfig;
748     private boolean _modeEdit;
749     private boolean _modeEditDefaults;
750     private boolean _modeEditGuest;
751     private boolean _modeHelp;
752     private boolean _modePreview;
753     private boolean _modePrint;
754     private boolean _showBackIcon;
755     private boolean _showCloseIcon;
756     private boolean _showConfigurationIcon;
757     private boolean _showEditIcon;
758     private boolean _showEditDefaultsIcon;
759     private boolean _showEditGuestIcon;
760     private boolean _showExportImportIcon;
761     private boolean _showHelpIcon;
762     private boolean _showMaxIcon;
763     private boolean _showMinIcon;
764     private boolean _showMoveIcon;
765     private boolean _showPortletCssIcon;
766     private boolean _showPortletIcon;
767     private boolean _showPrintIcon;
768     private boolean _showRefreshIcon;
769     private String _urlBack = StringPool.BLANK;
770     private String _urlClose = StringPool.BLANK;
771     private String _urlConfiguration = StringPool.BLANK;
772     private String _urlEdit = StringPool.BLANK;
773     private String _urlEditDefaults = StringPool.BLANK;
774     private String _urlEditGuest = StringPool.BLANK;
775     private String _urlExportImport = StringPool.BLANK;
776     private String _urlHelp = StringPool.BLANK;
777     private String _urlMax = StringPool.BLANK;
778     private String _urlMin = StringPool.BLANK;
779     private String _urlPortlet = StringPool.BLANK;
780     private String _urlPortletCss = StringPool.BLANK;
781     private String _urlPrint = StringPool.BLANK;
782     private String _urlRefresh = StringPool.BLANK;
783     private boolean _webDAVEnabled;
784     private boolean _restoreCurrentView;
785     private String _content = StringPool.BLANK;
786     private PortletPreferences _portletSetup;
787 
788 }