View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.portal.web.util;
35  
36  import fr.paris.lutece.portal.service.i18n.I18nService;
37  import fr.paris.lutece.util.html.Paginator;
38  
39  import java.util.List;
40  import java.util.Locale;
41  
42  
43  /**
44   * Localized Paginator
45   * @param <E> Item of the list
46   */
47  public class LocalizedPaginator<E> extends Paginator<E>
48  {
49      private static final long serialVersionUID = 6863575639914868230L;
50      private static final String KEY_FIRST = "portal.util.labelFirst";
51      private static final String KEY_PREVIOUS = "portal.util.labelPrevious";
52      private static final String KEY_NEXT = "portal.util.labelNext";
53      private static final String KEY_LAST = "portal.util.labelLast";
54      private static final String KEY_ITEM_COUNT = "portal.util.labelItemCount";
55      private static final String KEY_ITEM_COUNT_PER_PAGE = "portal.util.labelItemCountPerPage";
56      private Locale _locale;
57  
58      /**
59       * Creates a new instance of Paginator
60       * @param list The collection to paginate
61       * @param nItemPerPage Number of items to display per page
62       * @param strBaseUrl The base Url for build links on each page link
63       * @param strPageIndexParameterName The parameter name for the page index
64       * @param strPageIndex The current page index
65       * @param locale The Locale
66       */
67      public LocalizedPaginator( List<E> list, int nItemPerPage, String strBaseUrl, String strPageIndexParameterName,
68          String strPageIndex, Locale locale )
69      {
70          super( list, nItemPerPage, strBaseUrl, strPageIndexParameterName, strPageIndex );
71          _locale = locale;
72      }
73  
74      /**
75       * Creates a new instance of Paginator
76       * @param list The collection to paginate
77       * @param nItemPerPage Number of items to display per page
78       * @param strBaseUrl The base Url for build links on each page link
79       * @param strPageIndexParameterName The parameter name for the page index
80       * @param strPageIndex The current page index
81           * @param strItemsPerPageParameterName The parameter name of the number items per page
82       * @param locale The Locale
83       */
84      public LocalizedPaginator( List<E> list, int nItemPerPage, String strBaseUrl, String strPageIndexParameterName,
85          String strPageIndex, String strItemsPerPageParameterName, Locale locale )
86      {
87          this( list, nItemPerPage, strBaseUrl, strPageIndexParameterName, strPageIndex, locale );
88          setItemsPerPageParameterName( strItemsPerPageParameterName );
89      }
90  
91      /**
92       * {@inheritDoc }
93       */
94      @Override
95      public String getLabelFirst(  )
96      {
97          return I18nService.getLocalizedString( KEY_FIRST, _locale );
98      }
99  
100     /**
101      * {@inheritDoc }
102      */
103     @Override
104     public String getLabelPrevious(  )
105     {
106         return I18nService.getLocalizedString( KEY_PREVIOUS, _locale );
107     }
108 
109     /**
110      * {@inheritDoc }
111      */
112     @Override
113     public String getLabelNext(  )
114     {
115         return I18nService.getLocalizedString( KEY_NEXT, _locale );
116     }
117 
118     /**
119      * {@inheritDoc }
120      */
121     @Override
122     public String getLabelLast(  )
123     {
124         return I18nService.getLocalizedString( KEY_LAST, _locale );
125     }
126 
127     /**
128      * {@inheritDoc }
129      */
130     @Override
131     public String getLabelItemCount(  )
132     {
133         return I18nService.getLocalizedString( KEY_ITEM_COUNT, _locale );
134     }
135 
136     /**
137      * {@inheritDoc }
138      */
139     @Override
140     public String getLabelItemCountPerPage(  )
141     {
142         return I18nService.getLocalizedString( KEY_ITEM_COUNT_PER_PAGE, _locale );
143     }
144 }