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