1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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   * @author Eduardo Lundgren
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 String getDescription() {
122         return _description;
123     }
124 
125     public void setDescription(String description) {
126         description = HtmlUtil.escape(description);
127 
128         _description = description;
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 isShowHelpIcon() {
324         return _showHelpIcon;
325     }
326 
327     public void setShowHelpIcon(boolean showHelpIcon) {
328         _showHelpIcon = showHelpIcon;
329     }
330 
331     public boolean isShowMaxIcon() {
332         return _showMaxIcon;
333     }
334 
335     public void setShowMaxIcon(boolean showMaxIcon) {
336         _showMaxIcon = showMaxIcon;
337     }
338 
339     public boolean isShowMinIcon() {
340         return _showMinIcon;
341     }
342 
343     public void setShowMinIcon(boolean showMinIcon) {
344         _showMinIcon = showMinIcon;
345     }
346 
347     public boolean isShowMoveIcon() {
348         return _showMoveIcon;
349     }
350 
351     public void setShowMoveIcon(boolean showMoveIcon) {
352         _showMoveIcon = showMoveIcon;
353     }
354 
355     public boolean isShowPortletCssIcon() {
356         return _showPortletCssIcon;
357     }
358 
359     public void setShowPortletCssIcon(boolean showPortletCssIcon) {
360         _showPortletCssIcon = showPortletCssIcon;
361     }
362 
363     public boolean isShowPortletIcon() {
364         return _showPortletIcon;
365     }
366 
367     public void setShowPortletIcon(boolean showPortletIcon) {
368         _showPortletIcon = showPortletIcon;
369     }
370 
371     public boolean isShowPrintIcon() {
372         return _showPrintIcon;
373     }
374 
375     public void setShowPrintIcon(boolean showPrintIcon) {
376         _showPrintIcon = showPrintIcon;
377     }
378 
379     public boolean isShowRefreshIcon() {
380         return _showRefreshIcon;
381     }
382 
383     public void setShowRefreshIcon(boolean showRefreshIcon) {
384         _showRefreshIcon = showRefreshIcon;
385     }
386 
387     public String getURLBack() {
388         return _urlBack;
389     }
390 
391     public void setURLBack(String urlBack) {
392         _urlBack = urlBack;
393     }
394 
395     public String getURLClose() {
396         return _urlClose;
397     }
398 
399     public void setURLClose(String urlClose) {
400         _urlClose = urlClose;
401     }
402 
403     public String getURLConfiguration() {
404         return _urlConfiguration;
405     }
406 
407     public void setURLConfiguration(String urlConfiguration) {
408         _urlConfiguration = urlConfiguration;
409     }
410 
411     public String getURLEdit() {
412         return _urlEdit;
413     }
414 
415     public void setURLEdit(String urlEdit) {
416         _urlEdit = urlEdit;
417     }
418 
419     public String getURLEditDefaults() {
420         return _urlEditDefaults;
421     }
422 
423     public void setURLEditDefaults(String urlEditDefaults) {
424         _urlEditDefaults = urlEditDefaults;
425     }
426 
427     public String getURLEditGuest() {
428         return _urlEditGuest;
429     }
430 
431     public void setURLEditGuest(String urlEditGuest) {
432         _urlEditGuest = urlEditGuest;
433     }
434 
435     public String getURLHelp() {
436         return _urlHelp;
437     }
438 
439     public void setURLHelp(String urlHelp) {
440         _urlHelp = urlHelp;
441     }
442 
443     public String getURLMax() {
444         return _urlMax;
445     }
446 
447     public void setURLMax(String urlMax) {
448         _urlMax = urlMax;
449     }
450 
451     public String getURLMin() {
452         return _urlMin;
453     }
454 
455     public void setURLMin(String urlMin) {
456         _urlMin = urlMin;
457     }
458 
459     public String getURLPortlet() {
460         return _urlPortlet;
461     }
462 
463     public void setURLPortlet(String urlPortlet) {
464         _urlPortlet = urlPortlet;
465     }
466 
467     public String getURLPortletCss() {
468         return _urlPortletCss;
469     }
470 
471     public void setURLPortletCss(String urlPortletCss) {
472         _urlPortletCss = urlPortletCss;
473     }
474 
475     public String getURLPrint() {
476         return _urlPrint;
477     }
478 
479     public void setURLPrint(String urlPrint) {
480         _urlPrint = urlPrint;
481     }
482 
483     public String getURLRefresh() {
484         return _urlRefresh;
485     }
486 
487     public void setURLRefresh(String urlRefresh) {
488         _urlRefresh = urlRefresh;
489     }
490 
491     public boolean isRestoreCurrentView() {
492         return _restoreCurrentView;
493     }
494 
495     public void setRestoreCurrentView(boolean restoreCurrentView) {
496         _restoreCurrentView = restoreCurrentView;
497     }
498 
499     public String getContent() {
500         return _content;
501     }
502 
503     public void setContent(String content) {
504         _content = content;
505     }
506 
507     public PortletPreferences getPortletSetup() {
508         return _portletSetup;
509     }
510 
511     public void setPortletSetup(PortletPreferences portletSetup) {
512         _portletSetup = portletSetup;
513     }
514 
515     public void recycle() {
516         if (_log.isDebugEnabled()) {
517             _log.debug("Recycling instance " + hashCode());
518         }
519 
520         _id = StringPool.BLANK;
521         _rootPortletId = StringPool.BLANK;
522         _instanceId = StringPool.BLANK;
523         _resourcePK = StringPool.BLANK;
524         _portletName = StringPool.BLANK;
525         _namespace = StringPool.BLANK;
526         _title = StringPool.BLANK;
527         _description = StringPool.BLANK;
528         _access = false;
529         _active = false;
530         _columnId = StringPool.BLANK;
531         _stateExclusive = false;
532         _stateMax = false;
533         _stateMin = false;
534         _stateNormal = false;
535         _statePopUp = false;
536         _modeAbout = false;
537         _modeConfig = false;
538         _modeEdit = false;
539         _modeEditDefaults = false;
540         _modeEditGuest = false;
541         _modeHelp = false;
542         _modePreview = false;
543         _modePrint = false;
544         _showBackIcon = false;
545         _showCloseIcon = false;
546         _showConfigurationIcon = false;
547         _showEditIcon = false;
548         _showEditDefaultsIcon = false;
549         _showEditGuestIcon = false;
550         _showHelpIcon = false;
551         _showMaxIcon = false;
552         _showMinIcon = false;
553         _showMoveIcon = false;
554         _showPortletCssIcon = false;
555         _showPortletIcon = false;
556         _showPrintIcon = false;
557         _showRefreshIcon = false;
558         _urlBack = StringPool.BLANK;
559         _urlClose = StringPool.BLANK;
560         _urlConfiguration = StringPool.BLANK;
561         _urlEdit = StringPool.BLANK;
562         _urlEditDefaults = StringPool.BLANK;
563         _urlEditGuest = StringPool.BLANK;
564         _urlHelp = StringPool.BLANK;
565         _urlMax = StringPool.BLANK;
566         _urlMin = StringPool.BLANK;
567         _urlPortlet = StringPool.BLANK;
568         _urlPortletCss = StringPool.BLANK;
569         _urlPrint = StringPool.BLANK;
570         _urlRefresh = StringPool.BLANK;
571         _restoreCurrentView = false;
572         _content = StringPool.BLANK;
573         _portletSetup = null;
574     }
575 
576     public void copyFrom(PortletDisplay master) {
577         _themeDisplay = master.getThemeDisplay();
578         _id = master.getId();
579         _rootPortletId = master.getRootPortletId();
580         _instanceId = master.getInstanceId();
581         _resourcePK = master.getResourcePK();
582         _portletName = master.getPortletName();
583         _namespace = master.getNamespace();
584         _title = master.getTitle();
585         _description = master.getDescription();
586         _access = master.isAccess();
587         _active = master.isActive();
588         _columnId = master.getColumnId();
589         _stateExclusive = master.isStateExclusive();
590         _stateMax = master.isStateMax();
591         _stateMin = master.isStateMin();
592         _stateNormal = master.isStateNormal();
593         _statePopUp = master.isStatePopUp();
594         _modeAbout = master.isModeAbout();
595         _modeConfig = master.isModeConfig();
596         _modeEdit = master.isModeEdit();
597         _modeEditDefaults = master.isModeEditDefaults();
598         _modeEditGuest = master.isModeEditGuest();
599         _modeHelp = master.isModeHelp();
600         _modePreview = master.isModePreview();
601         _modePrint = master.isModePrint();
602         _showBackIcon = master.isShowBackIcon();
603         _showCloseIcon = master.isShowCloseIcon();
604         _showConfigurationIcon = master.isShowConfigurationIcon();
605         _showEditIcon = master.isShowEditIcon();
606         _showEditDefaultsIcon = master.isShowEditDefaultsIcon();
607         _showEditGuestIcon = master.isShowEditGuestIcon();
608         _showHelpIcon = master.isShowHelpIcon();
609         _showMaxIcon = master.isShowMaxIcon();
610         _showMinIcon = master.isShowMinIcon();
611         _showMoveIcon = master.isShowMoveIcon();
612         _showPortletCssIcon = master.isShowPortletCssIcon();
613         _showPortletIcon = master.isShowPortletIcon();
614         _showPrintIcon = master.isShowPrintIcon();
615         _showRefreshIcon = master.isShowRefreshIcon();
616         _urlBack = master.getURLBack();
617         _urlClose = master.getURLClose();
618         _urlConfiguration = master.getURLConfiguration();
619         _urlEdit = master.getURLEdit();
620         _urlEditDefaults = master.getURLEditDefaults();
621         _urlEditGuest = master.getURLEditGuest();
622         _urlHelp = master.getURLHelp();
623         _urlMax = master.getURLMax();
624         _urlMin = master.getURLMin();
625         _urlPortlet = master.getURLPortlet();
626         _urlPortletCss = master.getURLPortletCss();
627         _urlPrint = master.getURLPrint();
628         _urlRefresh = master.getURLRefresh();
629         _restoreCurrentView = master.isRestoreCurrentView();
630         _content = master.getContent();
631         _portletSetup = master.getPortletSetup();
632     }
633 
634     public void copyTo(PortletDisplay slave) {
635         slave.setThemeDisplay(_themeDisplay);
636         slave.setId(_id);
637         slave.setRootPortletId(_rootPortletId);
638         slave.setInstanceId(_instanceId);
639         slave.setResourcePK(_resourcePK);
640         slave.setPortletName(_portletName);
641         slave.setNamespace(_namespace);
642         slave.setTitle(_title);
643         slave.setDescription(_description);
644         slave.setAccess(_access);
645         slave.setActive(_active);
646         slave.setColumnId(_columnId);
647         slave.setStateExclusive(_stateExclusive);
648         slave.setStateMax(_stateMax);
649         slave.setStateMin(_stateMin);
650         slave.setStateNormal(_stateNormal);
651         slave.setStatePopUp(_statePopUp);
652         slave.setModeAbout(_modeAbout);
653         slave.setModeConfig(_modeConfig);
654         slave.setModeEdit(_modeEdit);
655         slave.setModeEditDefaults(_modeEditDefaults);
656         slave.setModeEditGuest(_modeEditGuest);
657         slave.setModeHelp(_modeHelp);
658         slave.setModePreview(_modePreview);
659         slave.setModePrint(_modePrint);
660         slave.setShowBackIcon(_showBackIcon);
661         slave.setShowCloseIcon(_showCloseIcon);
662         slave.setShowConfigurationIcon(_showConfigurationIcon);
663         slave.setShowEditIcon(_showEditIcon);
664         slave.setShowEditDefaultsIcon(_showEditDefaultsIcon);
665         slave.setShowEditGuestIcon(_showEditGuestIcon);
666         slave.setShowHelpIcon(_showHelpIcon);
667         slave.setShowMaxIcon(_showMaxIcon);
668         slave.setShowMinIcon(_showMinIcon);
669         slave.setShowMoveIcon(_showMoveIcon);
670         slave.setShowPortletCssIcon(_showPortletCssIcon);
671         slave.setShowPortletIcon(_showPortletIcon);
672         slave.setShowPrintIcon(_showPrintIcon);
673         slave.setShowRefreshIcon(_showRefreshIcon);
674         slave.setURLBack(_urlBack);
675         slave.setURLClose(_urlClose);
676         slave.setURLConfiguration(_urlConfiguration);
677         slave.setURLEdit(_urlEdit);
678         slave.setURLEditDefaults(_urlEditDefaults);
679         slave.setURLEditGuest(_urlEditGuest);
680         slave.setURLHelp(_urlHelp);
681         slave.setURLMax(_urlMax);
682         slave.setURLMin(_urlMin);
683         slave.setURLPortlet(_urlPortlet);
684         slave.setURLPortletCss(_urlPortletCss);
685         slave.setURLPrint(_urlPrint);
686         slave.setURLRefresh(_urlRefresh);
687         slave.setRestoreCurrentView(_restoreCurrentView);
688         slave.setContent(_content);
689         slave.setPortletSetup(_portletSetup);
690     }
691 
692     private static Log _log = LogFactoryUtil.getLog(PortletDisplay.class);
693 
694     private ThemeDisplay _themeDisplay;
695     private String _id = StringPool.BLANK;
696     private String _rootPortletId = StringPool.BLANK;
697     private String _instanceId = StringPool.BLANK;
698     private String _resourcePK = StringPool.BLANK;
699     private String _portletName = StringPool.BLANK;
700     private String _namespace = StringPool.BLANK;
701     private String _title = StringPool.BLANK;
702     private String _description = StringPool.BLANK;
703     private boolean _access;
704     private boolean _active;
705     private String _columnId = StringPool.BLANK;
706     private int _columnPos;
707     private int _columnCount;
708     private boolean _stateExclusive;
709     private boolean _stateMax;
710     private boolean _stateMin;
711     private boolean _stateNormal;
712     private boolean _statePopUp;
713     private boolean _modeAbout;
714     private boolean _modeConfig;
715     private boolean _modeEdit;
716     private boolean _modeEditDefaults;
717     private boolean _modeEditGuest;
718     private boolean _modeHelp;
719     private boolean _modePreview;
720     private boolean _modePrint;
721     private boolean _showBackIcon;
722     private boolean _showCloseIcon;
723     private boolean _showConfigurationIcon;
724     private boolean _showEditIcon;
725     private boolean _showEditDefaultsIcon;
726     private boolean _showEditGuestIcon;
727     private boolean _showHelpIcon;
728     private boolean _showMaxIcon;
729     private boolean _showMinIcon;
730     private boolean _showMoveIcon;
731     private boolean _showPortletCssIcon;
732     private boolean _showPortletIcon;
733     private boolean _showPrintIcon;
734     private boolean _showRefreshIcon;
735     private String _urlBack = StringPool.BLANK;
736     private String _urlClose = StringPool.BLANK;
737     private String _urlConfiguration = StringPool.BLANK;
738     private String _urlEdit = StringPool.BLANK;
739     private String _urlEditDefaults = StringPool.BLANK;
740     private String _urlEditGuest = StringPool.BLANK;
741     private String _urlHelp = StringPool.BLANK;
742     private String _urlMax = StringPool.BLANK;
743     private String _urlMin = StringPool.BLANK;
744     private String _urlPortlet = StringPool.BLANK;
745     private String _urlPortletCss = StringPool.BLANK;
746     private String _urlPrint = StringPool.BLANK;
747     private String _urlRefresh = StringPool.BLANK;
748     private boolean _restoreCurrentView;
749     private String _content = StringPool.BLANK;
750     private PortletPreferences _portletSetup;
751 
752 }