IDataGridMessageKeys


1   /*
2    * Copyright 2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * $Header:$
17   */
18  package org.apache.beehive.netui.databinding.datagrid.api.rendering;
19  
20  /**
21   * <p>
22   * This interfaces exposes a set of message keys that are used by the data grid when
23   * looking-up message values for text and other strings during rendering.
24   * </p>
25   * <p>
26   * Custom resource bundles implemented with Java property files can be exposed via a
27   * {@link org.apache.beehive.netui.databinding.datagrid.api.DataGridResourceProvider}.  Such property files
28   * should contain message keys whose values match the values of the messages keys defined here.
29   * </p>
30   */
31  public interface IDataGridMessageKeys {
32  
33      /**
34       * <p>
35       * String key for the message displayed when no data is available in the data set to which
36       * a data grid is bound.
37       * <br/>
38       * <b>Default value:</b><i>No data to display</i>
39       */
40      String   DATAGRID_MSG_NODATA = "datagrid.msg.nodata";
41  
42      /**
43       * <p>
44       * String key for the root resource path used when building a URL to resources such as images rendered
45       * in a data grid.
46       * <br/>
47       * <b>Default value:</b><i>resources/beehive/version1/images</i>
48       * </p>
49       */
50      String   DATAGRID_RESOURCE_PATH = "datagrid.resource.path";
51  
52      /**
53       * <p>
54       * String key for the name of an image used when rendering the ascending sort direction.
55       * <br/>
56       * <b>Default value:</b><i>/sortdown.gif</i>
57       * </p>
58       */
59      String   SORT_ASC_IMAGE_PATH = "sort.asc.img";
60  
61      /**
62       * <p>
63       * String key for the name of an image used when rendering the descending sort direction.
64       * <br/>
65       * <b>Default value:</b><i>/sortup.gif</i>
66       * </p>
67       */
68      String   SORT_DESC_IMAGE_PATH = "sort.desc.img";
69  
70      /**
71       * <p>
72       * String key for the name of an image used when rendering the no sort direction.
73       * <br/>
74       * <b>Default value:</b><i>/sortup.gif</i>
75       * </p>
76       */
77      String   SORT_NONE_IMAGE_PATH = "sort.none.img";
78  
79      /**
80       * <p>
81       * String key for the text displayed when rendering a link for paging to the first page of a data set.
82       * <br/>
83       * <b>Default value:</b><i>First</i>
84       * </p>
85       */
86      String   PAGER_MSG_FIRST = "pager.msg.first";
87  
88      /**
89       * <p>
90       * String key for the text displayed when rendering a link for paging to the logical next page of a data set.
91       * <br/>
92       * <b>Default value:</b><i>Next</i>
93       * </p>
94       */
95      String   PAGER_MSG_NEXT = "pager.msg.next";
96  
97      /**
98       * <p>
99       * String key for the text displayed when rendering a link for paging to the logical previous page of a data set.
100      * <br/>
101      * <b>Default value:</b><i>Previous</i>
102      * </p>
103      */
104     String   PAGER_MSG_PREVIOUS = "pager.msg.previous";
105 
106     /**
107      * <p>
108      * String key for the text displayed when rendering a link for paging to the last page of a data set.
109      * <br/>
110      * <b>Default value:</b><i>Last</i>
111      * </p>
112      */
113     String   PAGER_MSG_LAST = "pager.msg.last";
114 
115     /**
116      * <p>
117      * String key for the text displayed in a pager label when showing Page # of #.
118      * <br/>
119      * <b>Default value:</b><i>Page {0} of {1}</i>
120      * The <code>{0}</code> is substituted with a 1-based value for the current page.  The <code>{1}</code> is
121      * substituted with a 1-based value for the last page.
122      * </p>
123      */
124     String   PAGER_FMT_BANNER = "pager.fmt.banner";
125 }
126
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags