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