001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: * $Header:$
018: */
019: package org.apache.beehive.netui.databinding.datagrid.api.rendering;
020:
021: /**
022: * <p>
023: * This interfaces exposes a set of message keys that are used by the data grid when
024: * looking-up message values for text and other strings during rendering.
025: * </p>
026: * <p>
027: * Custom resource bundles implemented with Java property files can be exposed via a
028: * {@link org.apache.beehive.netui.databinding.datagrid.api.DataGridResourceProvider}. Such property files
029: * should contain message keys whose values match the values of the messages keys defined here.
030: * </p>
031: */
032: public interface IDataGridMessageKeys {
033:
034: /**
035: * <p>
036: * String key for the message displayed when no data is available in the data set to which
037: * a data grid is bound.
038: * <br/>
039: * <b>Default value:</b><i>No data to display</i>
040: */
041: String DATAGRID_MSG_NODATA = "datagrid.msg.nodata";
042:
043: /**
044: * <p>
045: * String key for the root resource path used when building a URL to resources such as images rendered
046: * in a data grid.
047: * <br/>
048: * <b>Default value:</b><i>resources/beehive/version1/images</i>
049: * </p>
050: */
051: String DATAGRID_RESOURCE_PATH = "datagrid.resource.path";
052:
053: /**
054: * <p>
055: * String key for the name of an image used when rendering the ascending sort direction.
056: * <br/>
057: * <b>Default value:</b><i>/sortdown.gif</i>
058: * </p>
059: */
060: String SORT_ASC_IMAGE_PATH = "sort.asc.img";
061:
062: /**
063: * <p>
064: * String key for the name of an image used when rendering the descending sort direction.
065: * <br/>
066: * <b>Default value:</b><i>/sortup.gif</i>
067: * </p>
068: */
069: String SORT_DESC_IMAGE_PATH = "sort.desc.img";
070:
071: /**
072: * <p>
073: * String key for the name of an image used when rendering the no sort direction.
074: * <br/>
075: * <b>Default value:</b><i>/sortup.gif</i>
076: * </p>
077: */
078: String SORT_NONE_IMAGE_PATH = "sort.none.img";
079:
080: /**
081: * <p>
082: * String key for the text displayed when rendering a link for paging to the first page of a data set.
083: * <br/>
084: * <b>Default value:</b><i>First</i>
085: * </p>
086: */
087: String PAGER_MSG_FIRST = "pager.msg.first";
088:
089: /**
090: * <p>
091: * String key for the text displayed when rendering a link for paging to the logical next page of a data set.
092: * <br/>
093: * <b>Default value:</b><i>Next</i>
094: * </p>
095: */
096: String PAGER_MSG_NEXT = "pager.msg.next";
097:
098: /**
099: * <p>
100: * String key for the text displayed when rendering a link for paging to the logical previous page of a data set.
101: * <br/>
102: * <b>Default value:</b><i>Previous</i>
103: * </p>
104: */
105: String PAGER_MSG_PREVIOUS = "pager.msg.previous";
106:
107: /**
108: * <p>
109: * String key for the text displayed when rendering a link for paging to the last page of a data set.
110: * <br/>
111: * <b>Default value:</b><i>Last</i>
112: * </p>
113: */
114: String PAGER_MSG_LAST = "pager.msg.last";
115:
116: /**
117: * <p>
118: * String key for the text displayed in a pager label when showing Page # of #.
119: * <br/>
120: * <b>Default value:</b><i>Page {0} of {1}</i>
121: * The <code>{0}</code> is substituted with a 1-based value for the current page. The <code>{1}</code> is
122: * substituted with a 1-based value for the last page.
123: * </p>
124: */
125: String PAGER_FMT_BANNER = "pager.fmt.banner";
126: }
|