/[debian]/libjgraph-java/trunk/doc/api/org/jgraph/graph/GraphSelectionModel.html
ViewVC logotype

Annotation of /libjgraph-java/trunk/doc/api/org/jgraph/graph/GraphSelectionModel.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 816 - (hide annotations)
Fri Aug 3 13:14:15 2007 UTC (14 years ago) by gregoa
File MIME type: text/html
File size: 31216 byte(s)
* New upstream release.
1 gregoa 441 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5 gregoa 816 <!-- Generated by javadoc (build 1.4.2_11) on Mon Jul 30 10:14:31 BST 2007 -->
6 gregoa 441 <TITLE>
7 gregoa 816 GraphSelectionModel (JGraph v5.10.1.4 API Specification)
8 gregoa 441 </TITLE>
9    
10     <META NAME="keywords" CONTENT="org.jgraph.graph.GraphSelectionModel interface">
11    
12     <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13    
14     <SCRIPT type="text/javascript">
15     function windowTitle()
16     {
17 gregoa 816 parent.document.title="GraphSelectionModel (JGraph v5.10.1.4 API Specification)";
18 gregoa 441 }
19     </SCRIPT>
20    
21     </HEAD>
22    
23     <BODY BGCOLOR="white" onload="windowTitle();">
24    
25    
26     <!-- ========= START OF TOP NAVBAR ======= -->
27     <A NAME="navbar_top"><!-- --></A>
28     <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29     <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30     <TR>
31     <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32     <A NAME="navbar_top_firstrow"><!-- --></A>
33     <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34     <TR ALIGN="center" VALIGN="top">
35     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37     <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GraphSelectionModel.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
39     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
40     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
41     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
42     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
43     </TR>
44     </TABLE>
45     </TD>
46     <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
47 gregoa 816 <p><b>JGraph</b><br>v5.10.1.4</p></EM>
48 gregoa 441 </TD>
49     </TR>
50    
51     <TR>
52     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53     &nbsp;<A HREF="../../../org/jgraph/graph/GraphModel.html" title="interface in org.jgraph.graph"><B>PREV CLASS</B></A>&nbsp;
54     &nbsp;<A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph"><B>NEXT CLASS</B></A></FONT></TD>
55     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56     <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
57     &nbsp;<A HREF="GraphSelectionModel.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
58     &nbsp;<SCRIPT type="text/javascript">
59     <!--
60     if(window==top) {
61     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
62     }
63     //-->
64     </SCRIPT>
65     <NOSCRIPT>
66     <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
67     </NOSCRIPT>
68    
69     </FONT></TD>
70     </TR>
71     <TR>
72     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
73     SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
74     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75     DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
76     </TR>
77     </TABLE>
78     <A NAME="skip-navbar_top"></A>
79     <!-- ========= END OF TOP NAVBAR ========= -->
80    
81     <HR>
82     <!-- ======== START OF CLASS DATA ======== -->
83     <H2>
84     <FONT SIZE="-1">
85     org.jgraph.graph</FONT>
86     <BR>
87     Interface GraphSelectionModel</H2>
88     <DL>
89     <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/jgraph/graph/DefaultGraphSelectionModel.html" title="class in org.jgraph.graph">DefaultGraphSelectionModel</A></DD>
90     </DL>
91     <HR>
92     <DL>
93     <DT>public interface <B>GraphSelectionModel</B></DL>
94    
95     <P>
96     This interface represents the current state of the selection for
97     the graph component.
98     <p>
99    
100     A GraphSelectionModel can be configured to allow only one
101     cell (<code>SINGLE_GRAPH_SELECTION</code>) or a number of
102     cells (<code>MULTIPLE_GRAPH_SELECTION</code>).
103     <P>
104    
105     <P>
106     <HR>
107    
108     <P>
109     <!-- ======== NESTED CLASS SUMMARY ======== -->
110    
111    
112     <!-- =========== FIELD SUMMARY =========== -->
113    
114     <A NAME="field_summary"><!-- --></A>
115     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117     <TD COLSPAN=2><FONT SIZE="+2">
118     <B>Field Summary</B></FONT></TD>
119     </TR>
120     <TR BGCOLOR="white" CLASS="TableRowColor">
121     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122     <CODE>static&nbsp;int</CODE></FONT></TD>
123     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#MULTIPLE_GRAPH_SELECTION">MULTIPLE_GRAPH_SELECTION</A></B></CODE>
124    
125     <BR>
126     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Selection can contain any number of items.</TD>
127     </TR>
128     <TR BGCOLOR="white" CLASS="TableRowColor">
129     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130     <CODE>static&nbsp;int</CODE></FONT></TD>
131     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#SINGLE_GRAPH_SELECTION">SINGLE_GRAPH_SELECTION</A></B></CODE>
132    
133     <BR>
134     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Selection can only contain one cell at a time.</TD>
135     </TR>
136     </TABLE>
137     &nbsp;
138     <!-- ======== CONSTRUCTOR SUMMARY ======== -->
139    
140    
141     <!-- ========== METHOD SUMMARY =========== -->
142    
143     <A NAME="method_summary"><!-- --></A>
144     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146     <TD COLSPAN=2><FONT SIZE="+2">
147     <B>Method Summary</B></FONT></TD>
148     </TR>
149     <TR BGCOLOR="white" CLASS="TableRowColor">
150     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151     <CODE>&nbsp;void</CODE></FONT></TD>
152     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#addGraphSelectionListener(org.jgraph.event.GraphSelectionListener)">addGraphSelectionListener</A></B>(<A HREF="../../../org/jgraph/event/GraphSelectionListener.html" title="interface in org.jgraph.event">GraphSelectionListener</A>&nbsp;x)</CODE>
153    
154     <BR>
155     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds x to the list of listeners that are notified each time the
156     set of selected Objects changes.</TD>
157     </TR>
158     <TR BGCOLOR="white" CLASS="TableRowColor">
159     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160     <CODE>&nbsp;void</CODE></FONT></TD>
161     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#addPropertyChangeListener(java.beans.PropertyChangeListener)">addPropertyChangeListener</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans">PropertyChangeListener</A>&nbsp;listener)</CODE>
162    
163     <BR>
164     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a PropertyChangeListener to the listener list.</TD>
165     </TR>
166     <TR BGCOLOR="white" CLASS="TableRowColor">
167     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168     <CODE>&nbsp;void</CODE></FONT></TD>
169     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#addSelectionCell(java.lang.Object)">addSelectionCell</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</CODE>
170    
171     <BR>
172     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds cell to the current selection.</TD>
173     </TR>
174     <TR BGCOLOR="white" CLASS="TableRowColor">
175     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176     <CODE>&nbsp;void</CODE></FONT></TD>
177     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#addSelectionCells(java.lang.Object[])">addSelectionCells</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</CODE>
178    
179     <BR>
180     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds cells to the current selection.</TD>
181     </TR>
182     <TR BGCOLOR="white" CLASS="TableRowColor">
183     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184     <CODE>&nbsp;void</CODE></FONT></TD>
185     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#clearSelection()">clearSelection</A></B>()</CODE>
186    
187     <BR>
188     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Empties the current selection.</TD>
189     </TR>
190     <TR BGCOLOR="white" CLASS="TableRowColor">
191     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192     <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD>
193     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#getSelectables()">getSelectables</A></B>()</CODE>
194    
195     <BR>
196     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the cells that are currently selectable.</TD>
197     </TR>
198     <TR BGCOLOR="white" CLASS="TableRowColor">
199     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200     <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
201     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#getSelectionCell()">getSelectionCell</A></B>()</CODE>
202    
203     <BR>
204     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the first cell in the selection.</TD>
205     </TR>
206     <TR BGCOLOR="white" CLASS="TableRowColor">
207     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208     <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD>
209     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#getSelectionCells()">getSelectionCells</A></B>()</CODE>
210    
211     <BR>
212     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the cells in the selection.</TD>
213     </TR>
214     <TR BGCOLOR="white" CLASS="TableRowColor">
215     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216     <CODE>&nbsp;int</CODE></FONT></TD>
217     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#getSelectionCount()">getSelectionCount</A></B>()</CODE>
218    
219     <BR>
220     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of cells that are selected.</TD>
221     </TR>
222     <TR BGCOLOR="white" CLASS="TableRowColor">
223     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224     <CODE>&nbsp;int</CODE></FONT></TD>
225     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#getSelectionMode()">getSelectionMode</A></B>()</CODE>
226    
227     <BR>
228     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current selection mode, either
229     <code>SINGLE_GRAPH_SELECTION</code> or
230     <code>MULTIPLE_GRAPH_SELECTION</code>.</TD>
231     </TR>
232     <TR BGCOLOR="white" CLASS="TableRowColor">
233     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234     <CODE>&nbsp;boolean</CODE></FONT></TD>
235     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#isCellSelected(java.lang.Object)">isCellSelected</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</CODE>
236    
237     <BR>
238     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the cell, <code>cell</code>, is in the current
239     selection.</TD>
240     </TR>
241     <TR BGCOLOR="white" CLASS="TableRowColor">
242     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243     <CODE>&nbsp;boolean</CODE></FONT></TD>
244     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#isChildrenSelectable()">isChildrenSelectable</A></B>()</CODE>
245    
246     <BR>
247     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the selection model allows the selection
248     of children.</TD>
249     </TR>
250     <TR BGCOLOR="white" CLASS="TableRowColor">
251     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252     <CODE>&nbsp;boolean</CODE></FONT></TD>
253     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#isChildrenSelected(java.lang.Object)">isChildrenSelected</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</CODE>
254    
255     <BR>
256     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the cell, <code>cell</code>,
257     has selected children.</TD>
258     </TR>
259     <TR BGCOLOR="white" CLASS="TableRowColor">
260     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261     <CODE>&nbsp;boolean</CODE></FONT></TD>
262     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#isSelectionEmpty()">isSelectionEmpty</A></B>()</CODE>
263    
264     <BR>
265     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the selection is currently empty.</TD>
266     </TR>
267     <TR BGCOLOR="white" CLASS="TableRowColor">
268     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269     <CODE>&nbsp;void</CODE></FONT></TD>
270     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#removeGraphSelectionListener(org.jgraph.event.GraphSelectionListener)">removeGraphSelectionListener</A></B>(<A HREF="../../../org/jgraph/event/GraphSelectionListener.html" title="interface in org.jgraph.event">GraphSelectionListener</A>&nbsp;x)</CODE>
271    
272     <BR>
273     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes x from the list of listeners that are notified each time
274     the set of selected Objects changes.</TD>
275     </TR>
276     <TR BGCOLOR="white" CLASS="TableRowColor">
277     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278     <CODE>&nbsp;void</CODE></FONT></TD>
279     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#removePropertyChangeListener(java.beans.PropertyChangeListener)">removePropertyChangeListener</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans">PropertyChangeListener</A>&nbsp;listener)</CODE>
280    
281     <BR>
282     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a PropertyChangeListener from the listener list.</TD>
283     </TR>
284     <TR BGCOLOR="white" CLASS="TableRowColor">
285     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286     <CODE>&nbsp;void</CODE></FONT></TD>
287     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#removeSelectionCell(java.lang.Object)">removeSelectionCell</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</CODE>
288    
289     <BR>
290     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes cell from the selection.</TD>
291     </TR>
292     <TR BGCOLOR="white" CLASS="TableRowColor">
293     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294     <CODE>&nbsp;void</CODE></FONT></TD>
295     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#removeSelectionCells(java.lang.Object[])">removeSelectionCells</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</CODE>
296    
297     <BR>
298     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes cells from the selection.</TD>
299     </TR>
300     <TR BGCOLOR="white" CLASS="TableRowColor">
301     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302     <CODE>&nbsp;void</CODE></FONT></TD>
303     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#setChildrenSelectable(boolean)">setChildrenSelectable</A></B>(boolean&nbsp;flag)</CODE>
304    
305     <BR>
306     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets if the selection model allows the selection
307     of children.</TD>
308     </TR>
309     <TR BGCOLOR="white" CLASS="TableRowColor">
310     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311     <CODE>&nbsp;void</CODE></FONT></TD>
312     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#setSelectionCell(java.lang.Object)">setSelectionCell</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</CODE>
313    
314     <BR>
315     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the selection to cell.</TD>
316     </TR>
317     <TR BGCOLOR="white" CLASS="TableRowColor">
318     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319     <CODE>&nbsp;void</CODE></FONT></TD>
320     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#setSelectionCells(java.lang.Object[])">setSelectionCells</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</CODE>
321    
322     <BR>
323     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the selection to cells.</TD>
324     </TR>
325     <TR BGCOLOR="white" CLASS="TableRowColor">
326     <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327     <CODE>&nbsp;void</CODE></FONT></TD>
328     <TD><CODE><B><A HREF="../../../org/jgraph/graph/GraphSelectionModel.html#setSelectionMode(int)">setSelectionMode</A></B>(int&nbsp;mode)</CODE>
329    
330     <BR>
331     &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the selection model, which must be either
332     SINGLE_GRAPH_SELECTION or MULTIPLE_GRAPH_SELECTION.</TD>
333     </TR>
334     </TABLE>
335     &nbsp;
336     <P>
337    
338     <!-- ============ FIELD DETAIL =========== -->
339    
340     <A NAME="field_detail"><!-- --></A>
341     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
342     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
343     <TD COLSPAN=1><FONT SIZE="+2">
344     <B>Field Detail</B></FONT></TD>
345     </TR>
346     </TABLE>
347    
348     <A NAME="SINGLE_GRAPH_SELECTION"><!-- --></A><H3>
349     SINGLE_GRAPH_SELECTION</H3>
350     <PRE>
351     public static final int <B>SINGLE_GRAPH_SELECTION</B></PRE>
352     <DL>
353     <DD>Selection can only contain one cell at a time.
354     <P>
355     <DL>
356     <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jgraph.graph.GraphSelectionModel.SINGLE_GRAPH_SELECTION">Constant Field Values</A></DL>
357     </DL>
358     <HR>
359    
360     <A NAME="MULTIPLE_GRAPH_SELECTION"><!-- --></A><H3>
361     MULTIPLE_GRAPH_SELECTION</H3>
362     <PRE>
363     public static final int <B>MULTIPLE_GRAPH_SELECTION</B></PRE>
364     <DL>
365     <DD>Selection can contain any number of items.
366     <P>
367     <DL>
368     <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.jgraph.graph.GraphSelectionModel.MULTIPLE_GRAPH_SELECTION">Constant Field Values</A></DL>
369     </DL>
370    
371     <!-- ========= CONSTRUCTOR DETAIL ======== -->
372    
373    
374     <!-- ============ METHOD DETAIL ========== -->
375    
376     <A NAME="method_detail"><!-- --></A>
377     <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
378     <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
379     <TD COLSPAN=1><FONT SIZE="+2">
380     <B>Method Detail</B></FONT></TD>
381     </TR>
382     </TABLE>
383    
384     <A NAME="setSelectionMode(int)"><!-- --></A><H3>
385     setSelectionMode</H3>
386     <PRE>
387     public void <B>setSelectionMode</B>(int&nbsp;mode)</PRE>
388     <DL>
389     <DD>Sets the selection model, which must be either
390     SINGLE_GRAPH_SELECTION or MULTIPLE_GRAPH_SELECTION.
391     <p>
392     This may change the selection if the current selection is not valid
393     for the new mode.
394     <P>
395     <DD><DL>
396     </DL>
397     </DD>
398     </DL>
399     <HR>
400    
401     <A NAME="setChildrenSelectable(boolean)"><!-- --></A><H3>
402     setChildrenSelectable</H3>
403     <PRE>
404     public void <B>setChildrenSelectable</B>(boolean&nbsp;flag)</PRE>
405     <DL>
406     <DD>Sets if the selection model allows the selection
407     of children.
408     <P>
409     <DD><DL>
410     </DL>
411     </DD>
412     </DL>
413     <HR>
414    
415     <A NAME="isChildrenSelectable()"><!-- --></A><H3>
416     isChildrenSelectable</H3>
417     <PRE>
418     public boolean <B>isChildrenSelectable</B>()</PRE>
419     <DL>
420     <DD>Returns true if the selection model allows the selection
421     of children.
422     <P>
423     <DD><DL>
424     </DL>
425     </DD>
426     </DL>
427     <HR>
428    
429     <A NAME="getSelectionMode()"><!-- --></A><H3>
430     getSelectionMode</H3>
431     <PRE>
432     public int <B>getSelectionMode</B>()</PRE>
433     <DL>
434     <DD>Returns the current selection mode, either
435     <code>SINGLE_GRAPH_SELECTION</code> or
436     <code>MULTIPLE_GRAPH_SELECTION</code>.
437     <P>
438     <DD><DL>
439     </DL>
440     </DD>
441     </DL>
442     <HR>
443    
444     <A NAME="setSelectionCell(java.lang.Object)"><!-- --></A><H3>
445     setSelectionCell</H3>
446     <PRE>
447     public void <B>setSelectionCell</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</PRE>
448     <DL>
449     <DD>Sets the selection to cell. If this represents a change, then
450     the GraphSelectionListeners are notified. If <code>cell</code> is
451     null, this has the same effect as invoking <code>clearSelection</code>.
452     <P>
453     <DD><DL>
454     <DT><B>Parameters:</B><DD><CODE>cell</CODE> - new cell to select</DL>
455     </DD>
456     </DL>
457     <HR>
458    
459     <A NAME="setSelectionCells(java.lang.Object[])"><!-- --></A><H3>
460     setSelectionCells</H3>
461     <PRE>
462     public void <B>setSelectionCells</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</PRE>
463     <DL>
464     <DD>Sets the selection to cells. If this represents a change, then
465     the GraphSelectionListeners are notified. If <code>cells</code> is
466     null, this has the same effect as invoking <code>clearSelection</code>.
467     <P>
468     <DD><DL>
469     <DT><B>Parameters:</B><DD><CODE>cells</CODE> - new selection</DL>
470     </DD>
471     </DL>
472     <HR>
473    
474     <A NAME="addSelectionCell(java.lang.Object)"><!-- --></A><H3>
475     addSelectionCell</H3>
476     <PRE>
477     public void <B>addSelectionCell</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</PRE>
478     <DL>
479     <DD>Adds cell to the current selection. If cell is not currently
480     in the selection the GraphSelectionListeners are notified. This has
481     no effect if <code>cell</code> is null.
482     <P>
483     <DD><DL>
484     <DT><B>Parameters:</B><DD><CODE>cell</CODE> - the new cell to add to the current selection</DL>
485     </DD>
486     </DL>
487     <HR>
488    
489     <A NAME="addSelectionCells(java.lang.Object[])"><!-- --></A><H3>
490     addSelectionCells</H3>
491     <PRE>
492     public void <B>addSelectionCells</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</PRE>
493     <DL>
494     <DD>Adds cells to the current selection. If any of the cells are
495     not currently in the selection the GraphSelectionListeners
496     are notified. This has no effect if <code>cells</code> is null.
497     <P>
498     <DD><DL>
499     <DT><B>Parameters:</B><DD><CODE>cells</CODE> - the new cells to add to the current selection</DL>
500     </DD>
501     </DL>
502     <HR>
503    
504     <A NAME="removeSelectionCell(java.lang.Object)"><!-- --></A><H3>
505     removeSelectionCell</H3>
506     <PRE>
507     public void <B>removeSelectionCell</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</PRE>
508     <DL>
509     <DD>Removes cell from the selection. If cell is in the selection
510     the GraphSelectionListeners are notified. This has no effect if
511     <code>cell</code> is null.
512     <P>
513     <DD><DL>
514     <DT><B>Parameters:</B><DD><CODE>cell</CODE> - the cell to remove from the selection</DL>
515     </DD>
516     </DL>
517     <HR>
518    
519     <A NAME="removeSelectionCells(java.lang.Object[])"><!-- --></A><H3>
520     removeSelectionCells</H3>
521     <PRE>
522     public void <B>removeSelectionCells</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]&nbsp;cells)</PRE>
523     <DL>
524     <DD>Removes cells from the selection. If any of the cells in
525     <code>cells</code> are in the selection, the
526     GraphSelectionListeners are notified. This method has no
527     effect if <code>cells</code> is null.
528     <P>
529     <DD><DL>
530     <DT><B>Parameters:</B><DD><CODE>cells</CODE> - the cells to remove from the selection</DL>
531     </DD>
532     </DL>
533     <HR>
534    
535     <A NAME="getSelectables()"><!-- --></A><H3>
536     getSelectables</H3>
537     <PRE>
538     public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>getSelectables</B>()</PRE>
539     <DL>
540     <DD>Returns the cells that are currently selectable.
541     <P>
542     <DD><DL>
543     </DL>
544     </DD>
545     </DL>
546     <HR>
547    
548     <A NAME="getSelectionCell()"><!-- --></A><H3>
549     getSelectionCell</H3>
550     <PRE>
551     public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getSelectionCell</B>()</PRE>
552     <DL>
553     <DD>Returns the first cell in the selection. How first is defined is
554     up to implementors.
555     <P>
556     <DD><DL>
557     </DL>
558     </DD>
559     </DL>
560     <HR>
561    
562     <A NAME="getSelectionCells()"><!-- --></A><H3>
563     getSelectionCells</H3>
564     <PRE>
565     public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] <B>getSelectionCells</B>()</PRE>
566     <DL>
567     <DD>Returns the cells in the selection. This will return null (or an
568     empty array) if nothing is currently selected.
569     <P>
570     <DD><DL>
571     </DL>
572     </DD>
573     </DL>
574     <HR>
575    
576     <A NAME="getSelectionCount()"><!-- --></A><H3>
577     getSelectionCount</H3>
578     <PRE>
579     public int <B>getSelectionCount</B>()</PRE>
580     <DL>
581     <DD>Returns the number of cells that are selected.
582     <P>
583     <DD><DL>
584     </DL>
585     </DD>
586     </DL>
587     <HR>
588    
589     <A NAME="isCellSelected(java.lang.Object)"><!-- --></A><H3>
590     isCellSelected</H3>
591     <PRE>
592     public boolean <B>isCellSelected</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</PRE>
593     <DL>
594     <DD>Returns true if the cell, <code>cell</code>, is in the current
595     selection.
596     <P>
597     <DD><DL>
598     </DL>
599     </DD>
600     </DL>
601     <HR>
602    
603     <A NAME="isChildrenSelected(java.lang.Object)"><!-- --></A><H3>
604     isChildrenSelected</H3>
605     <PRE>
606     public boolean <B>isChildrenSelected</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;cell)</PRE>
607     <DL>
608     <DD>Returns true if the cell, <code>cell</code>,
609     has selected children.
610     <P>
611     <DD><DL>
612     </DL>
613     </DD>
614     </DL>
615     <HR>
616    
617     <A NAME="isSelectionEmpty()"><!-- --></A><H3>
618     isSelectionEmpty</H3>
619     <PRE>
620     public boolean <B>isSelectionEmpty</B>()</PRE>
621     <DL>
622     <DD>Returns true if the selection is currently empty.
623     <P>
624     <DD><DL>
625     </DL>
626     </DD>
627     </DL>
628     <HR>
629    
630     <A NAME="clearSelection()"><!-- --></A><H3>
631     clearSelection</H3>
632     <PRE>
633     public void <B>clearSelection</B>()</PRE>
634     <DL>
635     <DD>Empties the current selection. If this represents a change in the
636     current selection, the selection listeners are notified.
637     <P>
638     <DD><DL>
639     </DL>
640     </DD>
641     </DL>
642     <HR>
643    
644     <A NAME="addPropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3>
645     addPropertyChangeListener</H3>
646     <PRE>
647     public void <B>addPropertyChangeListener</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans">PropertyChangeListener</A>&nbsp;listener)</PRE>
648     <DL>
649     <DD>Adds a PropertyChangeListener to the listener list.
650     The listener is registered for all properties.
651     <p>
652     A PropertyChangeEvent will get fired when the selection mode
653     changes.
654     <P>
655     <DD><DL>
656     <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the PropertyChangeListener to be added</DL>
657     </DD>
658     </DL>
659     <HR>
660    
661     <A NAME="removePropertyChangeListener(java.beans.PropertyChangeListener)"><!-- --></A><H3>
662     removePropertyChangeListener</H3>
663     <PRE>
664     public void <B>removePropertyChangeListener</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/beans/PropertyChangeListener.html" title="class or interface in java.beans">PropertyChangeListener</A>&nbsp;listener)</PRE>
665     <DL>
666     <DD>Removes a PropertyChangeListener from the listener list.
667     This removes a PropertyChangeListener that was registered
668     for all properties.
669     <P>
670     <DD><DL>
671     <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the PropertyChangeListener to be removed</DL>
672     </DD>
673     </DL>
674     <HR>
675    
676     <A NAME="addGraphSelectionListener(org.jgraph.event.GraphSelectionListener)"><!-- --></A><H3>
677     addGraphSelectionListener</H3>
678     <PRE>
679     public void <B>addGraphSelectionListener</B>(<A HREF="../../../org/jgraph/event/GraphSelectionListener.html" title="interface in org.jgraph.event">GraphSelectionListener</A>&nbsp;x)</PRE>
680     <DL>
681     <DD>Adds x to the list of listeners that are notified each time the
682     set of selected Objects changes.
683     <P>
684     <DD><DL>
685     <DT><B>Parameters:</B><DD><CODE>x</CODE> - the new listener to be added</DL>
686     </DD>
687     </DL>
688     <HR>
689    
690     <A NAME="removeGraphSelectionListener(org.jgraph.event.GraphSelectionListener)"><!-- --></A><H3>
691     removeGraphSelectionListener</H3>
692     <PRE>
693     public void <B>removeGraphSelectionListener</B>(<A HREF="../../../org/jgraph/event/GraphSelectionListener.html" title="interface in org.jgraph.event">GraphSelectionListener</A>&nbsp;x)</PRE>
694     <DL>
695     <DD>Removes x from the list of listeners that are notified each time
696     the set of selected Objects changes.
697     <P>
698     <DD><DL>
699     <DT><B>Parameters:</B><DD><CODE>x</CODE> - the listener to remove</DL>
700     </DD>
701     </DL>
702     <!-- ========= END OF CLASS DATA ========= -->
703     <HR>
704    
705    
706     <!-- ======= START OF BOTTOM NAVBAR ====== -->
707     <A NAME="navbar_bottom"><!-- --></A>
708     <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
709     <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
710     <TR>
711     <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
712     <A NAME="navbar_bottom_firstrow"><!-- --></A>
713     <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
714     <TR ALIGN="center" VALIGN="top">
715     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
716     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
717     <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
718     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GraphSelectionModel.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
719     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
720     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
721     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
722     <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
723     </TR>
724     </TABLE>
725     </TD>
726     <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
727 gregoa 816 <p><b>JGraph</b><br>v5.10.1.4</p></EM>
728 gregoa 441 </TD>
729     </TR>
730    
731     <TR>
732     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
733     &nbsp;<A HREF="../../../org/jgraph/graph/GraphModel.html" title="interface in org.jgraph.graph"><B>PREV CLASS</B></A>&nbsp;
734     &nbsp;<A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph"><B>NEXT CLASS</B></A></FONT></TD>
735     <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
736     <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
737     &nbsp;<A HREF="GraphSelectionModel.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
738     &nbsp;<SCRIPT type="text/javascript">
739     <!--
740     if(window==top) {
741     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
742     }
743     //-->
744     </SCRIPT>
745     <NOSCRIPT>
746     <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
747     </NOSCRIPT>
748    
749     </FONT></TD>
750     </TR>
751     <TR>
752     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
753     SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
754     <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
755     DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
756     </TR>
757     </TABLE>
758     <A NAME="skip-navbar_bottom"></A>
759     <!-- ======== END OF BOTTOM NAVBAR ======= -->
760    
761     <HR>
762     <font size=1>Copyright (C) 2001-2006 <a href="http://www.jgraph.com/"
763     target="_blank">Gaudenz Alder</a>. All rights reserved.</font>
764     </BODY>
765     </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26