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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
\name{gtree}
\alias{gtree}
\title{Constructor for widget to display heirarchical dta}
\description{
This widget allows tree-like data to be presented. Each node
on the tree should be a data frame with the same column
structure. The first column is treated like a key, and should
be unique. Offspring are specified through a function of the
keys which are ancestors. This function returns the data frame
to be displayed. Values in the tree can be selected with the
mouse. This value can be retrieved through a method, or a
handler can be assigned to double click events.
}
\usage{
gtree(offspring = NULL, hasOffspring = NULL, offspring.data = NULL,
col.types = NULL, icon.FUN = NULL, chosencol = 1, multiple = FALSE,
handler = NULL, action = NULL, container = NULL, ..., toolkit = guiToolkit())
}
\arguments{
\item{offspring}{A function to produce a data frame.
The first column of the data frame is used as a key. It should be
unique, otherwise the updating will not work properly.
The \code{offspring} function has two arguments, the first being the
path (the first column of the offspring data frame is the key, and
the path is the vector of keys) and the value of
\code{offspring.data}. The data frame can determine whether an
entry has offspring, by having the second column be a logical
vector, \code{TRUE} if there is offspring, \code{FALSE} if not.
}
\item{hasOffspring
}{
Whether an entry has an offspring is determined by a. if this
function is non-\code{NULL} and it returns a \code{TRUE} value when
called on the offspring data frame for this row, b. if this is NULL
and the second column of the offspring data frame is a logical vector
and for this row is \code{TRUE}. If this function is \code{NULL} and
the second column is not a logical vector then it is assumed that
there are no offspring.
}
\item{offspring.data}{Passed to \code{offspring} function to
parameterize that function.}
\item{col.types}{Used to determine the type of column, given as a
data frame with 1 or more rows. Otherwise it is determined by first
row of offspring data frame. If the offspring function can return an
empty data frame, then this argument should be given.}
\item{icon.FUN}{An optional function to determine an icon place into
the first column. This function gets called with the data in
\code{offspring}, and should return a row vector of length
\code{nrow(offspring)}. The icons are stock icons, and should be
referenced by name. The helper function \code{getStockIcons} list
all the available stock icons.}
\item{chosencol}{The column used when requesting the selected row's
value. Defaults to first}
\item{multiple}{ A logical to determine if multiple selection is
allowed. Defaults to \code{FALSE}}
\item{handler}{ Handler for double click events}
\item{action}{ Passed to handler }
\item{container}{Optional container to attach widget to.}
\item{...}{Passed to \code{add} method of container}
\item{toolkit}{Which GUI toolkit to use}
}
\details{
In an abstract sense, these trees are specified by a function which
produces the value at a given node from the ancestry of the given
node, and a function specifying if a node has offspring.
The \code{offspring} function determines the displayed data for a
certain node. It has signature \code{(path, offspring.data)}, where
the path consists of the ancestors and \code{offspring.data} is an
optional value passed in when the tree object is constructed. This
function returns a data frame. Its first column should consist of
unique values, as it is treated like a key.
The \code{hasOffspring} function is called on the return value of
\code{offspring}. It should return a logical indicating which rows
have offspring. If this argument is not present, then the second
column of the return values of \code{offspring} are consulted. If
these are logical, then they are used to determine if offspring are
present. Otherwise, no offspring are assumed.
The \code{icon.FUN} function is called on the return value of
\code{offspring}. If present, it should return a vector of stock
icon names.
The \code{svalue} method returns the current key. The \code{index}
argument has changed. If \code{index} is \code{TRUE}, the path of
each selection is returned as a numeric vector, where the numbers
represent the sibling count at each level, 1-based. That is
\code{c(1,2,3)} is the 3rd offspring of the second offspring of the
first offspring of the root. If more than one selection is made,
then a list of such values is returned. This way -- in theory -- we
can set values by index too. In particular, we should have
\code{svalue(obj, index=TRUE) <- svalue(obj, index=TRUE)}. (Before,
using a numeric value for index would give the ith column, as
opposed to the chosen column. This behaviour can be found using the
\code{"["} method.)
The \code{"["} method refers to the vector of keys for the selected
object. That is, svalue gives the current key, and \code{[} returns
the path of keys.
The \code{addHandlerDoubleclick} handler (also
\code{addHandlerChanged}) can be set to respond to
a double click event.
The \code{addHandlerClicked} handler should be called when the
selection is changed.
}
% \value{}
% \references{}
% \author{}
% \note{}
% \seealso{}
\examples{
\dontrun{
## function to find offspring
offspring <- function(path, offspring.data=NULL) {
if(length(path) > 0)
directory <- paste(getwd(), .Platform$file.sep,
paste(path,collapse=.Platform$file.sep),
sep="")
else
directory <- getwd()
files <- file.info(dir(path=directory, full.names=TRUE))[,c(1,2,3)]
files <- data.frame(filename=dir(path=directory),
isdir=files[,2],
size=as.integer(files[,1]),
mode=as.character(files[,3]),
stringsAsFactors=FALSE)
return(files)
}
hasOffspring <- function(children,offspring.data=NULL, ...) {
return(children$isdir)
}
icon.FUN <- function(children,offspring.data=NULL, ...) {
x <- rep("file", length=nrow(children))
x[children$isdir] <- "directory"
return(x)
}
## shows isdir directory, as hasOffspring is specified
w <- gwindow("test with isdir showing")
gtree(offspring, hasOffspring, icon.FUN = icon.FUN, container=w)
## does not show isdir directory, as hasOffspring=NULL and
## second column is a logical
w <- gwindow("tree test no dir column")
tr <- gtree(offspring, hasOffspring=NULL, icon.FUN = icon.FUN, container=w)
## Show a fixed list using a dynamic tree
l <- list(a=list(
aa=1,
ab=2,
ac=list(ac1=1)
),
b=list(
ba=list(
baa=1,
bab=list(
baba=1
)
)
))
offspring <- function(path, ...) {
print(path)
ll <- l
if(length(path) > 0) {
for(i in path)
ll <- ll[[i]]
}
out <- data.frame(name=names(ll),
hasOffspring=!sapply(ll, is.atomic),
value=as.character(sapply(ll, function(i) ifelse(is.atomic(i), i, ""))),
stringsAsFactors=FALSE)
out
}
w <- gwindow("Tree from list")
tr <- gtree(offspring=offspring, container=w)
addHandlerDoubleclick(tr, handler=function(h,...) {
print(svalue(h$obj)) # the key
print(h$obj[]) # vector of keys
})
}
}
\keyword{interface}% at least one, from doc/KEYWORDS
|
