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

Contents of /libjgraph-java/trunk/doc/api/org/jgraph/graph/Port.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 816 - (show annotations)
Fri Aug 3 13:14:15 2007 UTC (13 years, 10 months ago) by gregoa
File MIME type: text/html
File size: 12793 byte(s)
* New upstream release.
1 <!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 <!-- Generated by javadoc (build 1.4.2_11) on Mon Jul 30 10:14:31 BST 2007 -->
6 <TITLE>
7 Port (JGraph v5.10.1.4 API Specification)
8 </TITLE>
9
10 <META NAME="keywords" CONTENT="org.jgraph.graph.Port 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 parent.document.title="Port (JGraph v5.10.1.4 API Specification)";
18 }
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/Port.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 <p><b>JGraph</b><br>v5.10.1.4</p></EM>
48 </TD>
49 </TR>
50
51 <TR>
52 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53 &nbsp;<A HREF="../../../org/jgraph/graph/GraphSelectionModel.html" title="interface in org.jgraph.graph"><B>PREV CLASS</B></A>&nbsp;
54 &nbsp;NEXT CLASS</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="Port.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;FIELD&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;FIELD&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 Port</H2>
88 <DL>
89 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../org/jgraph/graph/GraphCell.html" title="interface in org.jgraph.graph">GraphCell</A></DD>
90 </DL>
91 <DL>
92 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/jgraph/graph/DefaultPort.html" title="class in org.jgraph.graph">DefaultPort</A></DD>
93 </DL>
94 <HR>
95 <DL>
96 <DT>public interface <B>Port</B><DT>extends <A HREF="../../../org/jgraph/graph/GraphCell.html" title="interface in org.jgraph.graph">GraphCell</A></DL>
97
98 <P>
99 Defines the requirements for an object that
100 represents a port in a graph model.
101 <P>
102
103 <P>
104 <HR>
105
106 <P>
107 <!-- ======== NESTED CLASS SUMMARY ======== -->
108
109
110 <!-- =========== FIELD SUMMARY =========== -->
111
112
113 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
114
115
116 <!-- ========== METHOD SUMMARY =========== -->
117
118 <A NAME="method_summary"><!-- --></A>
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121 <TD COLSPAN=2><FONT SIZE="+2">
122 <B>Method Summary</B></FONT></TD>
123 </TR>
124 <TR BGCOLOR="white" CLASS="TableRowColor">
125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126 <CODE>&nbsp;boolean</CODE></FONT></TD>
127 <TD><CODE><B><A HREF="../../../org/jgraph/graph/Port.html#addEdge(java.lang.Object)">addEdge</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;edge)</CODE>
128
129 <BR>
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds <code>edge</code> to the list of ports.</TD>
131 </TR>
132 <TR BGCOLOR="white" CLASS="TableRowColor">
133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A></CODE></FONT></TD>
135 <TD><CODE><B><A HREF="../../../org/jgraph/graph/Port.html#edges()">edges</A></B>()</CODE>
136
137 <BR>
138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an iterator of the edges connected
139 to the port.</TD>
140 </TR>
141 <TR BGCOLOR="white" CLASS="TableRowColor">
142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143 <CODE>&nbsp;<A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph">Port</A></CODE></FONT></TD>
144 <TD><CODE><B><A HREF="../../../org/jgraph/graph/Port.html#getAnchor()">getAnchor</A></B>()</CODE>
145
146 <BR>
147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the anchor of the port.</TD>
148 </TR>
149 <TR BGCOLOR="white" CLASS="TableRowColor">
150 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151 <CODE>&nbsp;boolean</CODE></FONT></TD>
152 <TD><CODE><B><A HREF="../../../org/jgraph/graph/Port.html#removeEdge(java.lang.Object)">removeEdge</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;edge)</CODE>
153
154 <BR>
155 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes <code>edge</code> from the list of ports.</TD>
156 </TR>
157 <TR BGCOLOR="white" CLASS="TableRowColor">
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159 <CODE>&nbsp;void</CODE></FONT></TD>
160 <TD><CODE><B><A HREF="../../../org/jgraph/graph/Port.html#setAnchor(org.jgraph.graph.Port)">setAnchor</A></B>(<A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph">Port</A>&nbsp;port)</CODE>
161
162 <BR>
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the anchor of the port.</TD>
164 </TR>
165 </TABLE>
166 &nbsp;<A NAME="methods_inherited_from_class_org.jgraph.graph.GraphCell"><!-- --></A>
167 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169 <TD><B>Methods inherited from interface org.jgraph.graph.<A HREF="../../../org/jgraph/graph/GraphCell.html" title="interface in org.jgraph.graph">GraphCell</A></B></TD>
170 </TR>
171 <TR BGCOLOR="white" CLASS="TableRowColor">
172 <TD><CODE><A HREF="../../../org/jgraph/graph/GraphCell.html#changeAttributes(java.util.Map)">changeAttributes</A>, <A HREF="../../../org/jgraph/graph/GraphCell.html#getAttributes()">getAttributes</A>, <A HREF="../../../org/jgraph/graph/GraphCell.html#setAttributes(org.jgraph.graph.AttributeMap)">setAttributes</A></CODE></TD>
173 </TR>
174 </TABLE>
175 &nbsp;
176 <P>
177
178 <!-- ============ FIELD DETAIL =========== -->
179
180
181 <!-- ========= CONSTRUCTOR DETAIL ======== -->
182
183
184 <!-- ============ METHOD DETAIL ========== -->
185
186 <A NAME="method_detail"><!-- --></A>
187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
189 <TD COLSPAN=1><FONT SIZE="+2">
190 <B>Method Detail</B></FONT></TD>
191 </TR>
192 </TABLE>
193
194 <A NAME="edges()"><!-- --></A><H3>
195 edges</H3>
196 <PRE>
197 public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A> <B>edges</B>()</PRE>
198 <DL>
199 <DD>Returns an iterator of the edges connected
200 to the port.
201 <P>
202 <DD><DL>
203 </DL>
204 </DD>
205 <DD><DL>
206 </DL>
207 </DD>
208 </DL>
209 <HR>
210
211 <A NAME="addEdge(java.lang.Object)"><!-- --></A><H3>
212 addEdge</H3>
213 <PRE>
214 public boolean <B>addEdge</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;edge)</PRE>
215 <DL>
216 <DD>Adds <code>edge</code> to the list of ports.
217 <P>
218 <DD><DL>
219 </DL>
220 </DD>
221 <DD><DL>
222 </DL>
223 </DD>
224 </DL>
225 <HR>
226
227 <A NAME="removeEdge(java.lang.Object)"><!-- --></A><H3>
228 removeEdge</H3>
229 <PRE>
230 public boolean <B>removeEdge</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;edge)</PRE>
231 <DL>
232 <DD>Removes <code>edge</code> from the list of ports.
233 <P>
234 <DD><DL>
235 </DL>
236 </DD>
237 <DD><DL>
238 </DL>
239 </DD>
240 </DL>
241 <HR>
242
243 <A NAME="getAnchor()"><!-- --></A><H3>
244 getAnchor</H3>
245 <PRE>
246 public <A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph">Port</A> <B>getAnchor</B>()</PRE>
247 <DL>
248 <DD>Returns the anchor of the port.
249 <P>
250 <DD><DL>
251 </DL>
252 </DD>
253 <DD><DL>
254 </DL>
255 </DD>
256 </DL>
257 <HR>
258
259 <A NAME="setAnchor(org.jgraph.graph.Port)"><!-- --></A><H3>
260 setAnchor</H3>
261 <PRE>
262 public void <B>setAnchor</B>(<A HREF="../../../org/jgraph/graph/Port.html" title="interface in org.jgraph.graph">Port</A>&nbsp;port)</PRE>
263 <DL>
264 <DD>Sets the anchor of the port.
265 <P>
266 <DD><DL>
267 </DL>
268 </DD>
269 <DD><DL>
270 </DL>
271 </DD>
272 </DL>
273 <!-- ========= END OF CLASS DATA ========= -->
274 <HR>
275
276
277 <!-- ======= START OF BOTTOM NAVBAR ====== -->
278 <A NAME="navbar_bottom"><!-- --></A>
279 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
280 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
281 <TR>
282 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
283 <A NAME="navbar_bottom_firstrow"><!-- --></A>
284 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
285 <TR ALIGN="center" VALIGN="top">
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
288 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Port.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
294 </TR>
295 </TABLE>
296 </TD>
297 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
298 <p><b>JGraph</b><br>v5.10.1.4</p></EM>
299 </TD>
300 </TR>
301
302 <TR>
303 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
304 &nbsp;<A HREF="../../../org/jgraph/graph/GraphSelectionModel.html" title="interface in org.jgraph.graph"><B>PREV CLASS</B></A>&nbsp;
305 &nbsp;NEXT CLASS</FONT></TD>
306 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
307 <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
308 &nbsp;<A HREF="Port.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
309 &nbsp;<SCRIPT type="text/javascript">
310 <!--
311 if(window==top) {
312 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
313 }
314 //-->
315 </SCRIPT>
316 <NOSCRIPT>
317 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
318 </NOSCRIPT>
319
320 </FONT></TD>
321 </TR>
322 <TR>
323 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
324 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
325 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
326 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
327 </TR>
328 </TABLE>
329 <A NAME="skip-navbar_bottom"></A>
330 <!-- ======== END OF BOTTOM NAVBAR ======= -->
331
332 <HR>
333 <font size=1>Copyright (C) 2001-2006 <a href="http://www.jgraph.com/"
334 target="_blank">Gaudenz Alder</a>. All rights reserved.</font>
335 </BODY>
336 </HTML>

  ViewVC Help
Powered by ViewVC 1.1.26