1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
\name{gtable}
\alias{gtable}
\title{Constructor for widget to display tabular data}
\description{
This widget displays either a vector, matrix or data frame in
a tabular format. The main usage is for user selection of a
row or rows.
}
\usage{
gtable(items, multiple = FALSE, chosencol = 1, icon.FUN = NULL,
filter.column = NULL, filter.labels = NULL, filter.FUN = NULL,
handler = NULL, action = NULL, container = NULL, ..., toolkit = guiToolkit())
}
\arguments{
\item{items}{A vector, matrix or data frame to be displayed. A
vector and matrix is coerced into a data frame.}
\item{multiple}{A logical. If \code{TRUE} multiple lines can be selected}
\item{chosencol}{By default, only the value in this column is
returned by the \code{svalue} method.}
\item{icon.FUN}{If given, this function is applied to the data frame
to be shown. It should return a vector of stock icon names}
\item{filter.column}{If not \code{NULL} a filter by droplist is
given which can be used to filter the displayed values shown using
the values in this column.}
\item{filter.labels}{If more complex filtering is desired then this argument populates the values of the combobox and the \code{filter.FUN} argument is used to specify a function to interpret these values.}
\item{filter.FUN}{Either a function with signature \code{(obj, filter.by)}
to specify a vector of logical values indicating which rows should
be shown or the character "manual" in which filtering is done directly through the \code{visible} method and not through a popup box}
\item{handler}{Called on a double click event}
\item{action}{Passed to handler}
\item{container}{Optional container to attach widget to}
\item{\dots}{ ignored }
\item{toolkit}{Which GUI toolkit to use}
}
\details{
The \code{svalue} method returns the selected value(s). By
default, only the value(s) in the chosen column are
returned. Use the argument \code{drop=FALSE} to return the
entire row. To return the row index, use the argument
\code{index=TRUE}. This index refers to the whole data store,
not just the visible portion when filtering is being used.
The \code{"["} notion treats the object like a data frame. When
filtering, this notation refers to the entire data frame, not
the visible data frame. The comment about the
returned index by \code{svalue} can be described by the fact that
\code{obj[svalue(obj,index=TRUE), ]} should be the same value as
\code{svalue(obj)}.
Assignment via \code{"[<-"} is possible with limitations imposed
by the toolkits. The graphical display of tabular matter is
usually done, similar to data frames, in terms of columns each
having the same type. For some toolkits, all values are
converted to characters, for others, the type must be
maintained. In R, coercion of types may occur when assigning to
a data frame, but this won't be so with the underlying toolkit widget.
To be portable across toolkits, the column type should not
change during assignment, nor should the number of rows be
reduced.
In particular, assignment with \code{"[<-"} for factors can
cause warnings if the values are not in the factor's
levels. When the value being assigned is a matrix there is a
coercion to a data frame which may change the type.
The \code{visible} and \code{visible<-} methods refer to which
rows of the data store are visible in the widget. These are
specified by a vector of class logical. This may be used when
there is filtering, not sorting. The value returned by
\code{svalue} is a logical vector of length given by the number
of rows of the data store, with \code{TRUE} indicating that the
row is displayed. When setting the visibility of a row through
\code{svalue} the vector of values should have the same length
as the number of rows, otherwise recycling occurs. (So
\code{visible(obj) <- TRUE} will work to display all the rows.)
The \code{length} method returns the length of the underlying
data store.
The \code{dim} method returns the dimension of the underlying
data store.
The \code{names} method returns the names of the underlying data
store.
The \code{names<-} method can be used to set the names of the
underlying data store and the values displayed in the column
headers of the widget.
Row names are ignored in the display of this widget.
A single click is used for selection of a value.
The \code{addHandlerDoubleclick} handler can be used to define a
callback to respond to a double click event.
}
% \value{}
% \references{}
% \author{}
\seealso{See also
\code{\link{gtree}} for displaying tree-like data and
\code{\link{gdf}} for tabular data meant to be edited
}
\examples{
\dontrun{
## example to select CRAN mirror
m <- getCRANmirrors()[,c(1,4)]
setCRAN <- function(URL) { ## see chooseCRANmirror
repos = getOption("repos")
repos["CRAN"] <- gsub("/$", "", URL)
options(repos=repos)
}
w <- gwindow("gtable example",width=400)
gp <- ggroup(horizontal=FALSE, container=w)
tab <- gtable(m, chosencol = 2, container=gp, expand=TRUE,
handler = function(h,...) setCRAN(svalue(h$obj)))
bg <- ggroup(container=gp)
addSpring(bg)
gbutton("dismiss", container=bg, handler = function(h,...) dispose(w))
## an example with icons.
## Select variables from a data frame
## find icons by class
icon.FUN <- function(items) {
dfName <- svalue(cb)
df <- try(get(dfName, envir=.GlobalEnv), silent=TRUE)
if(inherits(df,"try-error"))
return(rep(NULL,dim(items)[1]))
if(is.data.frame(items))
items <- items[,1, drop=TRUE]
sapply(items, function(i) {
class(df[,i])[1]
})
}
## list data frames in an environment
lsDF <- function(envir=.GlobalEnv) {
varNames <- ls(envir=envir)
dfs <- sapply(varNames, function(i) inherits(get(i,envir=envir),"data.frame"))
varNames[dfs]
}
## set up GUI
w <- gwindow("Select variables",width=250)
g <- ggroup(horizontal=FALSE, container=w)
l <- glabel("Data frame", container=g)
cb <- gcombobox(lsDF(), container=g)
blankDF = data.frame(variables=character(0), stringsAsFactors=FALSE)
tbl <- gtable(blankDF, icon.FUN=icon.FUN, container=g, expand=TRUE)
## add handlers
addHandlerChanged(cb, handler <- function(h,...) {
dfName <- svalue(h$obj)
dfNames <- names(get(dfName,envir=.GlobalEnv))
tbl[,] <- data.frame(variables=dfNames, stringsAsFactors=FALSE)
})
addHandlerClicked(tbl, handler = function(h,...) {
cat("Do something with",svalue(cb),"::", svalue(h$obj),"\n")
})
}
}
\keyword{interface}% at least one, from doc/KEYWORDS
|
