View Javadoc
1   /**
2    * This file Copyright (c) 2012-2017 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.contentapp.detail;
35  
36  import info.magnolia.ui.api.view.View;
37  
38  import com.vaadin.ui.Component;
39  
40  /**
41   * ItemView.
42   *
43   * @see DetailViewImpl
44   */
45  public interface DetailView extends View {
46  
47      void setItemView(Component formView, ViewType viewType);
48  
49      /**
50       * Enumeration for edit or preview types.
51       * <ul>
52       * <li>edit
53       * <li>view (preview)
54       * </ul>
55       */
56      enum ViewType {
57          ADD("add", "icon-add-item"),
58          EDIT("edit", "icon-edit"),
59          VIEW("view", "icon-view");
60  
61          private String text;
62          private String icon;
63  
64          ViewType(String text, String icon) {
65              this.text = text;
66              this.icon = icon;
67          }
68  
69          public String getText() {
70              return this.text;
71          }
72  
73          public String getIcon() {
74              return icon;
75          }
76  
77          public static ViewType fromString(String text) {
78              if (text != null && !text.isEmpty()) {
79                  for (ViewType type : ViewType.values()) {
80                      if (text.equalsIgnoreCase(type.text)) {
81                          return type;
82                      }
83                  }
84              }
85              return defaultViewType();
86  
87          }
88  
89          private static ViewType defaultViewType() {
90              return EDIT;
91          }
92  
93      }
94  
95      void setListener(Listener listener);
96  
97      void refresh();
98  
99      ViewType getViewType();
100 
101     void setWide(boolean isWide);
102 
103     /**
104      * Listener for the ContentView.
105      */
106     interface Listener {
107 
108     }
109 }