1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.forms.web.form.column.display;
35
36 import java.util.Locale;
37
38 import fr.paris.lutece.plugins.forms.business.form.column.FormColumnCell;
39 import fr.paris.lutece.plugins.forms.business.form.column.IFormColumn;
40 import fr.paris.lutece.plugins.forms.web.form.multiview.util.IFormListPosition;
41
42 /**
43 * Interface for a FormColumnDisplay objects
44 */
45 public interface IFormColumnDisplay extends IFormListPosition
46 {
47 /**
48 * Return the header template of the FormColumn
49 *
50 * @return the header template of the FormColumn
51 */
52 String getFormColumnHeaderTemplate( );
53
54 /**
55 * Build the header template of the FormColumn
56 *
57 * @param strSortUrl
58 * The url used to sort the column
59 * @param locale
60 * The locale to use to build the template
61 * @return the form column header template
62 */
63 String buildFormColumnHeaderTemplate( String strSortUrl, Locale locale );
64
65 /**
66 * Build the template of the given FormColumnCell for the FormColumn
67 *
68 * @param formColumnCell
69 * The FormColumnCell to use for build the template of the FormColumnDisplay
70 * @param locale
71 * The locale to use for build the template
72 * @return the template of the given formColumnCell
73 */
74 String buildFormColumnCellTemplate( FormColumnCell formColumnCell, Locale locale );
75
76 /**
77 * Return the FormColumn object associated to the FormColumnDisplay
78 *
79 * @return the FormColumn object associated to the FormColumnDisplay
80 */
81 IFormColumn getFormColumn( );
82
83 /**
84 * Set the FormColumn associated to the current FormColumnDisplay
85 *
86 * @param formColumn
87 * The FormColumn to associate to the FormColumnDisplay
88 */
89 void setFormColumn( IFormColumn formColumn );
90 }