1 /**
2 * This file Copyright (c) 2003-2011 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.module.admininterface.lists;
35
36 import info.magnolia.cms.gui.control.FunctionBar;
37 import info.magnolia.cms.gui.controlx.list.ListControl;
38 import info.magnolia.cms.gui.controlx.search.SearchConfig;
39 import info.magnolia.cms.gui.controlx.search.SearchableListModel;
40 import info.magnolia.cms.gui.controlx.search.SimpleSearchUtil;
41 import info.magnolia.cms.gui.query.SearchQuery;
42 import info.magnolia.freemarker.FreemarkerUtil;
43
44 import javax.servlet.http.HttpServletRequest;
45 import javax.servlet.http.HttpServletResponse;
46
47
48 /**
49 * @author Philipp Bracher
50 * @version $Revision: 44899 $ ($Author: dlipp $)
51 */
52 public abstract class AbstractSimpleSearchList extends AbstractList {
53
54 /**
55 * @param name
56 * @param request
57 * @param response
58 */
59 public AbstractSimpleSearchList(String name, HttpServletRequest request, HttpServletResponse response) {
60 super(name, request, response);
61 }
62
63 private String searchStr = "";
64
65 /**
66 * @see info.magnolia.module.admininterface.lists.AbstractList#onRender()
67 */
68 @Override
69 public String onRender() {
70 String str = super.onRender();
71 str += FreemarkerUtil.process(AbstractSimpleSearchList.class, this);
72 return str;
73 }
74
75 /**
76 * @return Returns the searchStr.
77 */
78 public String getSearchStr() {
79 return this.searchStr;
80 }
81
82 /**
83 * @param searchStr The searchStr to set.
84 */
85 public void setSearchStr(String searchStr) {
86 this.searchStr = searchStr;
87 }
88
89 /**
90 * @see info.magnolia.module.admininterface.lists.AbstractList#configureList(info.magnolia.cms.gui.controlx.list.ListControl)
91 */
92 @Override
93 public void initList(ListControl list) {
94 super.initList(list);
95 ((SearchableListModel) list.getModel()).setQuery(this.getQuery());
96 }
97
98 /**
99 * @return
100 */
101 public SearchQuery getQuery() {
102 if(this.getSearchConfig() == null){
103 return SimpleSearchUtil.getSimpleSearchQuery(this.getSearchStr());
104 }
105 return SimpleSearchUtil.getSimpleSearchQuery(this.getSearchStr(), this.getSearchConfig());
106 }
107
108 @Override
109 protected void configureFunctionBar(FunctionBar bar) {
110 super.configureFunctionBar(bar);
111 bar.setSearchable(true);
112 bar.setSearchStr(this.getSearchStr());
113 bar.setOnSearchFunction(this.getList().getName() + ".search");
114 }
115
116 /**
117 * @return
118 */
119 public abstract SearchConfig getSearchConfig();
120
121 }