1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   *
12   * 
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 boolean isAccess() {
124         return _access;
125     }
126 
127     public void setAccess(boolean access) {
128         _access = access;
129     }
130 
131     public boolean isActive() {
132         return _active;
133     }
134 
135     public void setActive(boolean active) {
136         _active = active;
137     }
138 
139     public String getColumnId() {
140         return _columnId;
141     }
142 
143     public void setColumnId(String columnId) {
144         _columnId = columnId;
145     }
146 
147     public int getColumnPos() {
148         return _columnPos;
149     }
150 
151     public void setColumnPos(int columnPos) {
152         _columnPos = columnPos;
153     }
154 
155     public int getColumnCount() {
156         return _columnCount;
157     }
158 
159     public void setColumnCount(int columnCount) {
160         _columnCount = columnCount;
161     }
162 
163     public boolean isStateExclusive() {
164         return _stateExclusive;
165     }
166 
167     public void setStateExclusive(boolean stateExclusive) {
168         _stateExclusive = stateExclusive;
169     }
170 
171     public boolean isStateMax() {
172         return _stateMax;
173     }
174 
175     public void setStateMax(boolean stateMax) {
176         _stateMax = stateMax;
177     }
178 
179     public boolean isStateMin() {
180         return _stateMin;
181     }
182 
183     public void setStateMin(boolean stateMin) {
184         _stateMin = stateMin;
185     }
186 
187     public boolean isStateNormal() {
188         return _stateNormal;
189     }
190 
191     public void setStateNormal(boolean stateNormal) {
192         _stateNormal = stateNormal;
193     }
194 
195     public boolean isStatePopUp() {
196         return _statePopUp;
197     }
198 
199     public void setStatePopUp(boolean statePopUp) {
200         _statePopUp = statePopUp;
201     }
202 
203     public boolean isModeAbout() {
204         return _modeAbout;
205     }
206 
207     public void setModeAbout(boolean modeAbout) {
208         _modeAbout = modeAbout;
209     }
210 
211     public boolean isModeConfig() {
212         return _modeConfig;
213     }
214 
215     public void setModeConfig(boolean modeConfig) {
216         _modeConfig = modeConfig;
217     }
218 
219     public boolean isModeEdit() {
220         return _modeEdit;
221     }
222 
223     public void setModeEdit(boolean modeEdit) {
224         _modeEdit = modeEdit;
225     }
226 
227     public boolean isModeEditDefaults() {
228         return _modeEditDefaults;
229     }
230 
231     public void setModeEditDefaults(boolean modeEditDefaults) {
232         _modeEditDefaults = modeEditDefaults;
233     }
234 
235     public boolean isModeEditGuest() {
236         return _modeEditGuest;
237     }
238 
239     public void setModeEditGuest(boolean modeEditGuest) {
240         _modeEditGuest = modeEditGuest;
241     }
242 
243     public boolean isModeHelp() {
244         return _modeHelp;
245     }
246 
247     public void setModeHelp(boolean modeHelp) {
248         _modeHelp = modeHelp;
249     }
250 
251     public boolean isModePreview() {
252         return _modePreview;
253     }
254 
255     public void setModePreview(boolean modePreview) {
256         _modePreview = modePreview;
257     }
258 
259     public boolean isModePrint() {
260         return _modePrint;
261     }
262 
263     public void setModePrint(boolean modePrint) {
264         _modePrint = modePrint;
265     }
266 
267     public boolean isShowBackIcon() {
268         return _showBackIcon;
269     }
270 
271     public void setShowBackIcon(boolean showBackIcon) {
272         _showBackIcon = showBackIcon;
273     }
274 
275     public boolean isShowCloseIcon() {
276         return _showCloseIcon;
277     }
278 
279     public void setShowCloseIcon(boolean showCloseIcon) {
280         _showCloseIcon = showCloseIcon;
281     }
282 
283     public boolean isShowConfigurationIcon() {
284         return _showConfigurationIcon;
285     }
286 
287     public void setShowConfigurationIcon(boolean showConfigurationIcon) {
288         _showConfigurationIcon = showConfigurationIcon;
289     }
290 
291     public boolean isShowEditIcon() {
292         return _showEditIcon;
293     }
294 
295     public void setShowEditIcon(boolean showEditIcon) {
296         _showEditIcon = showEditIcon;
297     }
298 
299     public boolean isShowEditDefaultsIcon() {
300         return _showEditDefaultsIcon;
301     }
302 
303     public void setShowEditDefaultsIcon(boolean showEditDefaultsIcon) {
304         _showEditDefaultsIcon = showEditDefaultsIcon;
305     }
306 
307     public boolean isShowEditGuestIcon() {
308         return _showEditGuestIcon;
309     }
310 
311     public void setShowEditGuestIcon(boolean showEditGuestIcon) {
312         _showEditGuestIcon = showEditGuestIcon;
313     }
314 
315     public boolean isShowHelpIcon() {
316         return _showHelpIcon;
317     }
318 
319     public void setShowHelpIcon(boolean showHelpIcon) {
320         _showHelpIcon = showHelpIcon;
321     }
322 
323     public boolean isShowMaxIcon() {
324         return _showMaxIcon;
325     }
326 
327     public void setShowMaxIcon(boolean showMaxIcon) {
328         _showMaxIcon = showMaxIcon;
329     }
330 
331     public boolean isShowMinIcon() {
332         return _showMinIcon;
333     }
334 
335     public void setShowMinIcon(boolean showMinIcon) {
336         _showMinIcon = showMinIcon;
337     }
338 
339     public boolean isShowMoveIcon() {
340         return _showMoveIcon;
341     }
342 
343     public void setShowMoveIcon(boolean showMoveIcon) {
344         _showMoveIcon = showMoveIcon;
345     }
346 
347     public boolean isShowPortletCssIcon() {
348         return _showPortletCssIcon;
349     }
350 
351     public void setShowPortletCssIcon(boolean showPortletCssIcon) {
352         _showPortletCssIcon = showPortletCssIcon;
353     }
354 
355     public boolean isShowPortletIcon() {
356         return _showPortletIcon;
357     }
358 
359     public void setShowPortletIcon(boolean showPortletIcon) {
360         _showPortletIcon = showPortletIcon;
361     }
362 
363     public boolean isShowPrintIcon() {
364         return _showPrintIcon;
365     }
366 
367     public void setShowPrintIcon(boolean showPrintIcon) {
368         _showPrintIcon = showPrintIcon;
369     }
370 
371     public boolean isShowRefreshIcon() {
372         return _showRefreshIcon;
373     }
374 
375     public void setShowRefreshIcon(boolean showRefreshIcon) {
376         _showRefreshIcon = showRefreshIcon;
377     }
378 
379     public String getURLBack() {
380         return _urlBack;
381     }
382 
383     public void setURLBack(String urlBack) {
384         _urlBack = urlBack;
385     }
386 
387     public String getURLClose() {
388         return _urlClose;
389     }
390 
391     public void setURLClose(String urlClose) {
392         _urlClose = urlClose;
393     }
394 
395     public String getURLConfiguration() {
396         return _urlConfiguration;
397     }
398 
399     public void setURLConfiguration(String urlConfiguration) {
400         _urlConfiguration = urlConfiguration;
401     }
402 
403     public String getURLEdit() {
404         return _urlEdit;
405     }
406 
407     public void setURLEdit(String urlEdit) {
408         _urlEdit = urlEdit;
409     }
410 
411     public String getURLEditDefaults() {
412         return _urlEditDefaults;
413     }
414 
415     public void setURLEditDefaults(String urlEditDefaults) {
416         _urlEditDefaults = urlEditDefaults;
417     }
418 
419     public String getURLEditGuest() {
420         return _urlEditGuest;
421     }
422 
423     public void setURLEditGuest(String urlEditGuest) {
424         _urlEditGuest = urlEditGuest;
425     }
426 
427     public String getURLHelp() {
428         return _urlHelp;
429     }
430 
431     public void setURLHelp(String urlHelp) {
432         _urlHelp = urlHelp;
433     }
434 
435     public String getURLMax() {
436         return _urlMax;
437     }
438 
439     public void setURLMax(String urlMax) {
440         _urlMax = urlMax;
441     }
442 
443     public String getURLMin() {
444         return _urlMin;
445     }
446 
447     public void setURLMin(String urlMin) {
448         _urlMin = urlMin;
449     }
450 
451     public String getURLPortlet() {
452         return _urlPortlet;
453     }
454 
455     public void setURLPortlet(String urlPortlet) {
456         _urlPortlet = urlPortlet;
457     }
458 
459     public String getURLPortletCss() {
460         return _urlPortletCss;
461     }
462 
463     public void setURLPortletCss(String urlPortletCss) {
464         _urlPortletCss = urlPortletCss;
465     }
466 
467     public String getURLPrint() {
468         return _urlPrint;
469     }
470 
471     public void setURLPrint(String urlPrint) {
472         _urlPrint = urlPrint;
473     }
474 
475     public String getURLRefresh() {
476         return _urlRefresh;
477     }
478 
479     public void setURLRefresh(String urlRefresh) {
480         _urlRefresh = urlRefresh;
481     }
482 
483     public boolean isRestoreCurrentView() {
484         return _restoreCurrentView;
485     }
486 
487     public void setRestoreCurrentView(boolean restoreCurrentView) {
488         _restoreCurrentView = restoreCurrentView;
489     }
490 
491     public String getContent() {
492         return _content;
493     }
494 
495     public void setContent(String content) {
496         _content = content;
497     }
498 
499     public PortletPreferences getPortletSetup() {
500         return _portletSetup;
501     }
502 
503     public void setPortletSetup(PortletPreferences portletSetup) {
504         _portletSetup = portletSetup;
505     }
506 
507     public void recycle() {
508         if (_log.isDebugEnabled()) {
509             _log.debug("Recycling instance " + hashCode());
510         }
511 
512         _id = StringPool.BLANK;
513         _rootPortletId = StringPool.BLANK;
514         _instanceId = StringPool.BLANK;
515         _resourcePK = StringPool.BLANK;
516         _portletName = StringPool.BLANK;
517         _namespace = StringPool.BLANK;
518         _title = StringPool.BLANK;
519         _description = StringPool.BLANK;
520         _access = false;
521         _active = false;
522         _columnId = StringPool.BLANK;
523         _stateExclusive = false;
524         _stateMax = false;
525         _stateMin = false;
526         _stateNormal = false;
527         _statePopUp = false;
528         _modeAbout = false;
529         _modeConfig = false;
530         _modeEdit = false;
531         _modeEditDefaults = false;
532         _modeEditGuest = false;
533         _modeHelp = false;
534         _modePreview = false;
535         _modePrint = false;
536         _showBackIcon = false;
537         _showCloseIcon = false;
538         _showConfigurationIcon = false;
539         _showEditIcon = false;
540         _showEditDefaultsIcon = false;
541         _showEditGuestIcon = false;
542         _showHelpIcon = false;
543         _showMaxIcon = false;
544         _showMinIcon = false;
545         _showMoveIcon = false;
546         _showPortletCssIcon = false;
547         _showPortletIcon = false;
548         _showPrintIcon = false;
549         _showRefreshIcon = false;
550         _urlBack = StringPool.BLANK;
551         _urlClose = StringPool.BLANK;
552         _urlConfiguration = StringPool.BLANK;
553         _urlEdit = StringPool.BLANK;
554         _urlEditDefaults = StringPool.BLANK;
555         _urlEditGuest = StringPool.BLANK;
556         _urlHelp = StringPool.BLANK;
557         _urlMax = StringPool.BLANK;
558         _urlMin = StringPool.BLANK;
559         _urlPortlet = StringPool.BLANK;
560         _urlPortletCss = StringPool.BLANK;
561         _urlPrint = StringPool.BLANK;
562         _urlRefresh = StringPool.BLANK;
563         _restoreCurrentView = false;
564         _content = StringPool.BLANK;
565         _portletSetup = null;
566     }
567 
568     public void copyFrom(PortletDisplay master) {
569         _themeDisplay = master.getThemeDisplay();
570         _id = master.getId();
571         _rootPortletId = master.getRootPortletId();
572         _instanceId = master.getInstanceId();
573         _resourcePK = master.getResourcePK();
574         _portletName = master.getPortletName();
575         _namespace = master.getNamespace();
576         _title = master.getTitle();
577         _description = master.getDescription();
578         _access = master.isAccess();
579         _active = master.isActive();
580         _columnId = master.getColumnId();
581         _stateExclusive = master.isStateExclusive();
582         _stateMax = master.isStateMax();
583         _stateMin = master.isStateMin();
584         _stateNormal = master.isStateNormal();
585         _statePopUp = master.isStatePopUp();
586         _modeAbout = master.isModeAbout();
587         _modeConfig = master.isModeConfig();
588         _modeEdit = master.isModeEdit();
589         _modeEditDefaults = master.isModeEditDefaults();
590         _modeEditGuest = master.isModeEditGuest();
591         _modeHelp = master.isModeHelp();
592         _modePreview = master.isModePreview();
593         _modePrint = master.isModePrint();
594         _showBackIcon = master.isShowBackIcon();
595         _showCloseIcon = master.isShowCloseIcon();
596         _showConfigurationIcon = master.isShowConfigurationIcon();
597         _showEditIcon = master.isShowEditIcon();
598         _showEditDefaultsIcon = master.isShowEditDefaultsIcon();
599         _showEditGuestIcon = master.isShowEditGuestIcon();
600         _showHelpIcon = master.isShowHelpIcon();
601         _showMaxIcon = master.isShowMaxIcon();
602         _showMinIcon = master.isShowMinIcon();
603         _showMoveIcon = master.isShowMoveIcon();
604         _showPortletCssIcon = master.isShowPortletCssIcon();
605         _showPortletIcon = master.isShowPortletIcon();
606         _showPrintIcon = master.isShowPrintIcon();
607         _showRefreshIcon = master.isShowRefreshIcon();
608         _urlBack = master.getURLBack();
609         _urlClose = master.getURLClose();
610         _urlConfiguration = master.getURLConfiguration();
611         _urlEdit = master.getURLEdit();
612         _urlEditDefaults = master.getURLEditDefaults();
613         _urlEditGuest = master.getURLEditGuest();
614         _urlHelp = master.getURLHelp();
615         _urlMax = master.getURLMax();
616         _urlMin = master.getURLMin();
617         _urlPortlet = master.getURLPortlet();
618         _urlPortletCss = master.getURLPortletCss();
619         _urlPrint = master.getURLPrint();
620         _urlRefresh = master.getURLRefresh();
621         _restoreCurrentView = master.isRestoreCurrentView();
622         _content = master.getContent();
623         _portletSetup = master.getPortletSetup();
624     }
625 
626     public void copyTo(PortletDisplay slave) {
627         slave.setThemeDisplay(_themeDisplay);
628         slave.setId(_id);
629         slave.setRootPortletId(_rootPortletId);
630         slave.setInstanceId(_instanceId);
631         slave.setResourcePK(_resourcePK);
632         slave.setPortletName(_portletName);
633         slave.setNamespace(_namespace);
634         slave.setTitle(_title);
635         slave.setDescription(_description);
636         slave.setAccess(_access);
637         slave.setActive(_active);
638         slave.setColumnId(_columnId);
639         slave.setStateExclusive(_stateExclusive);
640         slave.setStateMax(_stateMax);
641         slave.setStateMin(_stateMin);
642         slave.setStateNormal(_stateNormal);
643         slave.setStatePopUp(_statePopUp);
644         slave.setModeAbout(_modeAbout);
645         slave.setModeConfig(_modeConfig);
646         slave.setModeEdit(_modeEdit);
647         slave.setModeEditDefaults(_modeEditDefaults);
648         slave.setModeEditGuest(_modeEditGuest);
649         slave.setModeHelp(_modeHelp);
650         slave.setModePreview(_modePreview);
651         slave.setModePrint(_modePrint);
652         slave.setShowBackIcon(_showBackIcon);
653         slave.setShowCloseIcon(_showCloseIcon);
654         slave.setShowConfigurationIcon(_showConfigurationIcon);
655         slave.setShowEditIcon(_showEditIcon);
656         slave.setShowEditDefaultsIcon(_showEditDefaultsIcon);
657         slave.setShowEditGuestIcon(_showEditGuestIcon);
658         slave.setShowHelpIcon(_showHelpIcon);
659         slave.setShowMaxIcon(_showMaxIcon);
660         slave.setShowMinIcon(_showMinIcon);
661         slave.setShowMoveIcon(_showMoveIcon);
662         slave.setShowPortletCssIcon(_showPortletCssIcon);
663         slave.setShowPortletIcon(_showPortletIcon);
664         slave.setShowPrintIcon(_showPrintIcon);
665         slave.setShowRefreshIcon(_showRefreshIcon);
666         slave.setURLBack(_urlBack);
667         slave.setURLClose(_urlClose);
668         slave.setURLConfiguration(_urlConfiguration);
669         slave.setURLEdit(_urlEdit);
670         slave.setURLEditDefaults(_urlEditDefaults);
671         slave.setURLEditGuest(_urlEditGuest);
672         slave.setURLHelp(_urlHelp);
673         slave.setURLMax(_urlMax);
674         slave.setURLMin(_urlMin);
675         slave.setURLPortlet(_urlPortlet);
676         slave.setURLPortletCss(_urlPortletCss);
677         slave.setURLPrint(_urlPrint);
678         slave.setURLRefresh(_urlRefresh);
679         slave.setRestoreCurrentView(_restoreCurrentView);
680         slave.setContent(_content);
681         slave.setPortletSetup(_portletSetup);
682     }
683 
684     private static Log _log = LogFactoryUtil.getLog(PortletDisplay.class);
685 
686     private ThemeDisplay _themeDisplay;
687     private String _id = StringPool.BLANK;
688     private String _rootPortletId = StringPool.BLANK;
689     private String _instanceId = StringPool.BLANK;
690     private String _resourcePK = StringPool.BLANK;
691     private String _portletName = StringPool.BLANK;
692     private String _namespace = StringPool.BLANK;
693     private String _title = StringPool.BLANK;
694     private String _description = StringPool.BLANK;
695     private boolean _access;
696     private boolean _active;
697     private String _columnId = StringPool.BLANK;
698     private int _columnPos;
699     private int _columnCount;
700     private boolean _stateExclusive;
701     private boolean _stateMax;
702     private boolean _stateMin;
703     private boolean _stateNormal;
704     private boolean _statePopUp;
705     private boolean _modeAbout;
706     private boolean _modeConfig;
707     private boolean _modeEdit;
708     private boolean _modeEditDefaults;
709     private boolean _modeEditGuest;
710     private boolean _modeHelp;
711     private boolean _modePreview;
712     private boolean _modePrint;
713     private boolean _showBackIcon;
714     private boolean _showCloseIcon;
715     private boolean _showConfigurationIcon;
716     private boolean _showEditIcon;
717     private boolean _showEditDefaultsIcon;
718     private boolean _showEditGuestIcon;
719     private boolean _showHelpIcon;
720     private boolean _showMaxIcon;
721     private boolean _showMinIcon;
722     private boolean _showMoveIcon;
723     private boolean _showPortletCssIcon;
724     private boolean _showPortletIcon;
725     private boolean _showPrintIcon;
726     private boolean _showRefreshIcon;
727     private String _urlBack = StringPool.BLANK;
728     private String _urlClose = StringPool.BLANK;
729     private String _urlConfiguration = StringPool.BLANK;
730     private String _urlEdit = StringPool.BLANK;
731     private String _urlEditDefaults = StringPool.BLANK;
732     private String _urlEditGuest = StringPool.BLANK;
733     private String _urlHelp = StringPool.BLANK;
734     private String _urlMax = StringPool.BLANK;
735     private String _urlMin = StringPool.BLANK;
736     private String _urlPortlet = StringPool.BLANK;
737     private String _urlPortletCss = StringPool.BLANK;
738     private String _urlPrint = StringPool.BLANK;
739     private String _urlRefresh = StringPool.BLANK;
740     private boolean _restoreCurrentView;
741     private String _content = StringPool.BLANK;
742     private PortletPreferences _portletSetup;
743 
744 }