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