Document the role of PithosDisclosurePanel
[pithos-web-client] / src / gr / grnet / pithos / web / client / PithosDisclosurePanel.java
1 /*
2  * Copyright 2012-2013 GRNET S.A. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or
5  * without modification, are permitted provided that the following
6  * conditions are met:
7  *
8  *   1. Redistributions of source code must retain the above
9  *      copyright notice, this list of conditions and the following
10  *      disclaimer.
11  *
12  *   2. Redistributions in binary form must reproduce the above
13  *      copyright notice, this list of conditions and the following
14  *      disclaimer in the documentation and/or other materials
15  *      provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * The views and conclusions contained in the software and
31  * documentation are those of the authors and should not be
32  * interpreted as representing official policies, either expressed
33  * or implied, of GRNET S.A.
34  */
35
36 package gr.grnet.pithos.web.client;
37
38 import com.google.gwt.event.logical.shared.CloseEvent;
39 import com.google.gwt.event.logical.shared.CloseHandler;
40 import com.google.gwt.event.logical.shared.OpenEvent;
41 import com.google.gwt.event.logical.shared.OpenHandler;
42 import com.google.gwt.resources.client.ClientBundle;
43 import com.google.gwt.resources.client.CssResource;
44 import com.google.gwt.resources.client.ImageResource;
45 import com.google.gwt.user.client.ui.*;
46
47 public class PithosDisclosurePanel extends Composite {
48
49         public interface Style extends CssResource {
50                 String disclosurePanel();
51                 
52                 String header();
53                 
54                 String arrow();
55                 
56                 String content();
57         }
58         
59         public interface Resources extends ClientBundle {
60                 @Source("PithosDisclosurePanel.css")
61                 Style pithosDisclosurePanelCss();
62                 
63                 @Source("upArrow.png")
64                 ImageResource icon();
65                 
66                 @Source("upArrow.png")
67                 ImageResource open();
68                 
69                 @Source("downArrow.png")
70                 ImageResource closed();
71
72         @Source("gr/grnet/pithos/resources/ajax-loader.gif")
73         ImageResource ajaxLoader();
74         }
75         
76         private final DisclosurePanel panel;
77     private final Resources resources;
78     private final String title;
79
80     // This is the header of each one of the extra hierarchies named "Shared with me", "Shared by me" and "Groups".
81     // The previous strings are the values given to the title parameter of the constructor.
82         public PithosDisclosurePanel(final Resources _resources, final String title, boolean ajaxLoader, boolean open) {
83         this.title = title;
84
85                 this.resources = _resources;
86                 resources.pithosDisclosurePanelCss().ensureInjected();
87                 this.panel = new DisclosurePanel();
88                 panel.addStyleName(resources.pithosDisclosurePanelCss().disclosurePanel());
89                 panel.setHeader(createHeader(resources, title, ajaxLoader, open));
90                 panel.setOpen(open);
91
92         if(!ajaxLoader) {
93             addOpenCloseHandlers();
94         }
95
96                 initWidget(panel);
97         }
98
99     private void addOpenCloseHandlers() {
100         panel.addOpenHandler(new OpenHandler<DisclosurePanel>() {
101             @Override
102             public void onOpen(OpenEvent<DisclosurePanel> event) {
103                 panel.setHeader(createHeader(resources, title, false, true));
104             }
105         });
106         panel.addCloseHandler(new CloseHandler<DisclosurePanel>() {
107
108             @Override
109             public void onClose(CloseEvent<DisclosurePanel> event) {
110                 panel.setHeader(createHeader(resources, title, false, false));
111             }
112         });
113     }
114
115     public void setLoaded(boolean open) {
116         this.panel.setHeader(createHeader(resources, title, false, open));
117         addOpenCloseHandlers();
118     }
119         
120         Widget createHeader(Resources resources, String title, boolean ajaxLoader, boolean open) {
121                 HorizontalPanel header = new HorizontalPanel();
122         
123                 Image img = new Image(resources.icon());
124                 header.add(img);
125                 header.setCellVerticalAlignment(img, HasVerticalAlignment.ALIGN_MIDDLE);
126                 header.setCellWidth(img, "32px");
127                 HTML titleHtml = new HTML(title);
128                 header.add(titleHtml);
129                 header.setCellVerticalAlignment(titleHtml, HasVerticalAlignment.ALIGN_MIDDLE);
130                 Image arrow = new Image(ajaxLoader ? resources.ajaxLoader() : open ? resources.open() : resources.closed());
131                 arrow.addStyleName(resources.pithosDisclosurePanelCss().arrow());
132                 header.add(arrow);
133                 header.setCellHorizontalAlignment(arrow, HasHorizontalAlignment.ALIGN_RIGHT);
134                 header.setCellVerticalAlignment(arrow, HasVerticalAlignment.ALIGN_MIDDLE);
135                 
136                 header.addStyleName(resources.pithosDisclosurePanelCss().header());
137                 return header;
138         }
139         
140         public void setContent(Widget widget) {
141                 panel.setContent(widget);
142                 panel.getContent().removeStyleName("content");
143                 panel.getContent().addStyleName(resources.pithosDisclosurePanelCss().content());
144         }
145 }