Provides a means of displaying attribute information relating to the currently selected entities.
ID
com.cohga.html.client.main.gridView
Sub-tags
name |
type |
cardinality |
default |
description |
---|---|---|---|---|
label |
String |
0..1 |
|
Label to display in tab |
location |
String |
1..1 |
|
Which region to add the view to |
toolbar |
grid actions |
0..n |
|
A collection of tools to add to the panel |
format |
format definitions |
0..1 |
|
A collection of formatting options |
emptyMsg |
string |
0..1 |
"No data to display" |
Text to display for no results |
displayMsg |
string |
0..1 |
"Displaying {0} - {1} of {2}" |
Paging toolbar text |
beforePageText |
string |
0..1 |
"Page" |
Label before page number |
afterPageText |
string |
0..1 |
"of {0}" |
Text after page number |
firstText |
string |
0..1 |
"First Page" |
Tooltip for first page button |
prevText |
string |
0..1 |
"Previous Page" |
Tooltip for previous page button |
nextText |
string |
0..1 |
"Next Page" |
Tooptip for next page button |
lastText |
string |
0..1 |
"Last Page" |
Tooltip for last page button |
refreshText |
string |
0..1 |
"Refresh" |
Tooltip for refresh button |
itemsText |
string |
0..1 |
"Items per page" |
Text for items per page |
Example
Basic grid view
<view id='com.cohga.html.client.main.gridView'> <label>Identify</label> <location>south</location> </view>
Formatting a grid view
<view id="com.cohga.html.client.main.gridView"> <label>Data</label> <location>center.south</location> <toolbar> <!-- toolbar items go here --> </toolbar> <!-- override column widths --> <format> <!-- set column widths for columns in a specific data --> <data id="ar_property_details"> <column id="PropNo" width="20"/> <column id="OwnerName" width="200"/> </data> <data id="ar_road_details"> <column id="Status" width="10"/> <column id="Old_Status" hidden="true"/> </data> <!-- set column width globally for columns in any data --> <column id="RoadName" width="200"/> <column id="RoadType" width="50"/> <column id="Suburb" width="250"/> <column id="oid" hidden="true"/> </format> </view>
Formatting with snippet (for re-use of formatting)
<client:format id="custom"> <!-- set column widths for columns in a specific data --> <data id="ar_property_details"> <column id="PropNo" width="20"/> <column id="OwnerName" width="200"/> </data> <data id="ar_road_details"> <column id="Status" width="10"/> </data> <!-- set column width globally for columns in any data --> <column id="RoadName" width="200"/> <column id="RoadType" width="50"/> <column id="Suburb" width="250"/> </client:format> <client:config id="test"> <!-- there should be other config items here --> <view id="com.cohga.html.client.main.gridView"> <label>Data</label> <location>center.south</location> <toolbar> <!-- toolbar items go here --> </toolbar> <!-- override formatting --> <format ref="custom"/> </view> </client:config>
Localising the grid view
<client:config id="example"> <!-- there should be other config items here --> <view id="com.cohga.html.client.main.gridView"> <label>Data</label> <location>center.south</location> <emptyText>%nodata.text</emptyText> </view> <!-- there should be other config items here --> <client:config> <client:resources> <resource id="nodata.text">No data to display</resource> </client:resources> <client:resources lang="ru"> <resource id="nodata.text">Нет данных для отображения</resource> </client:resources> <client:resources lang="sv"> <resource id="nodata.text">Inga data för att visa</resource> </client:resources> <client:resources lang="it"> <resource id="nodata.text">Nessun dato da visualizzare</resource> </client:resources>
Date and Time formatting
You can also change the default date, time and date/time format by setting adding dateformat, timeformat and/or datetimeformat entries to the <data> section of the <defaults> section in the client config.
<client:config id="test"> ... <defaults> ... <data> <dateformat>Y-m-d</dateformat> <timeformat>H:i:s</timeformat> <datetimeformat>Y-m-d H:i:s</datetimeformat> </data> ... </defaults> </client:config>
Place-holders
name |
value |
format |
d |
Day of Month |
Numeric, 2 digits, left padded |
D |
Day of Week |
Text, long |
j |
Day of Month |
Numeric |
l |
Day of Week |
Text, short |
N |
Day of Week |
Numeric, 1=Monday, 7=Sunday |
S |
Day of Month Suffix |
Text, 'st', 'nd', 'rd', 'th' |
w |
Day of Week |
Numeric, 0=Sunday, 6=Saturday |
z |
Day of Year |
Numeric |
W |
Week of Year |
Numeric, 2 digits, left padded |
F |
Month |
Text, long |
m |
Month |
Numeric, 2 digits, left padded, January=01 |
M |
Month |
Text, short |
n |
Month |
Numeric, January=1 |
t |
Days in Month |
Numeric |
Y |
Year |
Numeric, 4 digits |
y |
Year |
Numeric, 2 digits |
a |
am/pm |
Text |
A |
AM/PM |
Text |
g |
Hour |
12 Hour, Numeric |
G |
Hour |
24 Hour, Numeric |
h |
Hour |
12 Hour, 2 digits, left padded |
H |
Hour |
24 Hour, 2 digits, left padded |
i |
Minute |
Numeric, 2 digits, left padded |
s |
Second |
Numeric, 2 digits, left padded |
u |
Milli-Second |
Numeric, 3 digits, left padded |
T |
Timezone |
String |