/[debian]/libjgraph-java/trunk/README
ViewVC logotype

Contents of /libjgraph-java/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 555 - (show annotations)
Mon Feb 26 16:34:45 2007 UTC (14 years, 2 months ago) by gregoa
File size: 8846 byte(s)
* New upstream release.
1 JGraph - The JFC/Swing Graph Component (c)2001-2006
2
3 A component to display and edit graphs (networks) with Java
4
5 by Gaudenz Alder
6
7
8 TABLE OF CONTENTS
9 *****************
10
11 1. Disclaimer
12 2. Installation
13 2.1 Requirements
14 2.2 Compiling
15 3. What is it?
16 3.1 Purpose
17 3.2 Features
18 3.3 History
19 4. Overview
20 4.1 Implementation
21 4.2 Architecture
22 5. Getting Help
23 5.1 Documentation
24 5.2 Support
25 6. Obtaining JGraph
26 6.1 Binaries
27 6.2 Source Code
28 7. Misc
29 7.1 Tips and tricks
30 7.2 Showcase
31 8. License
32 9. Contact Email
33
34
35
36 1. Disclaimer
37 -------------
38 Please read the license under which your version of JGraph is licensed for any
39 warranty limitation.
40
41
42 2. Installation
43 ---------------
44
45 2.1 Requirements
46 ----------------
47 o JGraph requires a Java 1.4 or later compatible virtual
48 machine for your operating system.
49 Java 1.5.x is known to work correctly.
50 o Apache Ant.
51
52 The most recent version of Java can be obtained from http://java.sun.com/j2se/
53 Compiling JGraph requires Ant. To obtain Ant go to http://ant.apache.org/
54 and select Binary Distributions of the left hand side navigation. Select the
55 nearest mirror then download the compressed file appropriate for your platform
56 (.zip for Windows and .tar.gz for UNIX). Then decompress the file into your
57 selected directory path for the Ant binaries.
58
59 2.2 Compiling
60 -------------
61 The project has the following directory structure:
62
63 src/ Source root
64 examples/ Examples root
65 build/ Build environment
66 dist-*/ Distributables
67
68 The compilation of JGraph requires Ant and the build.xml file. The same build
69 file is used for all distributions. However, the binary and source distribution
70 are only compatible with certain versions of Java.
71
72 o On Unix, type the following depending on the location of Java and Ant:
73 export JAVA_HOME=/usr/java/j2sdk1.4.1_12
74 export ANT_HOME=/usr/ant/ant-1.6.2
75 export PATH=$PATH:$JAVA_HOME/bin:$ANT_HOME/bin/
76
77 o On Windows, type the following depending on the location of Java and Ant:
78 set JAVA_HOME=c:\j2sdk1.4.1_12
79 set ANT_HOME=c:\ant-1.6.2
80 set PATH=%PATH%;%JAVA_HOME%\bin;%ANT_HOME%\bin
81
82 The build.xml file offers the following targets:
83
84 - all (*) --> Clean up and produce all distributions
85 - apidoc --> Generate the API specification (javadoc)
86 - build --> Run all tasks to completely populate the build directory
87 - clean --> Delete all generated files and directories
88 - compile --> Prepare (migrate) and compile the source tree
89 - prepare --> Copy source code to build directory
90 - dist --> Produce fresh distributions
91 - distclean --> Clean up the distribution files only
92 - doc --> Generate all documentation
93 - init --> Initialize the build; create directories, call tstamp
94 - jar --> Build all Java archives (JARs)
95 - make-example --> Compile the example tree
96 - example --> Run the main example UI
97
98 (*) all is the default target.
99
100 Target names may be appended to the above Java commands. For example,
101 to compile and run the example UI type the following:
102
103 ant example
104
105 3. What is it?
106 --------------
107 The intention of this project is to provide a freely
108 available and fully Swing compliant implementation of a
109 graph component.
110
111 3.1 Purpose
112 -----------
113 With the JGraph zoomable component, you can display objects
114 and relations (networks) in any Swing UI. JGraph can also be
115 used on the server-side, for example to read a GXL graph,
116 apply a custom layout algorithm, and return the result as an
117 SVG image.
118
119 3.2 Features
120 ------------
121 o Edge Editing: Add/Remove/Edit Points; Connect, Disconnect; Labels
122 o Moving/Sizing: Transaction-Based, with Live-Preview
123 o Selection: Single-Cell and Marquee Selection.
124 o Zoom: Arbitrary Zoom; Uses JavaTM 2D
125 o Layering: View-Dependent Inter- and Intracell Layering
126 o Grouping: Children Selectable; Uses Tree-Interface
127 o Grid:Customizable Size, Color, Appearance
128 o In-Place Editing: Direct Text Editing for all Cells
129 o View Attributes: Cells have Separate Attributes for each attached View
130 o Ports: Multiple Connection Points for each Cell
131 o Handles: Flexible Interface for Cell-Modifications
132 o Drag and Drop: Between JGraphs, JVMs and other applications/OS
133 o Clipboard: Supports Multiple Transfer Formats
134 o Command History: Multi-View; for all available Operations
135 o Look-and-Feel: All Swing Pluggable Look-and-Feels
136 o Routing: Customizable Routing with default algorithms
137 o Visibility: Hide edges, vertices and groups
138 o Attribute-Split: Per attribute control of view-only attributes
139 o Clustering: Folding/Unfolding of groups into vertices
140 o Ant-based: Ant-based build environment
141 o Precision: Double precision coordinates
142 o Labels: Draws labels along edges
143
144
145
146 4. Overview
147 -----------
148
149 4.1 Implementation
150 ------------------
151 The following design principles guided the implementation
152 of JGraph:
153
154 o Full Swing Compatibility
155 o Clear & Efficient Design
156 o Short Download Time
157 o 100 % Pure JavaTM
158
159 4.2 Architecture
160 ----------------
161 No need to learn another complex product! JGraph integrates
162 nicely into the Swing component class hierarchy, because it
163 is based on the Swing MVC pattern. The API and implementation
164 complies with the JavaTM Code Conventions. All classes in
165 JGraph have their equivalents in Swing, and all features are
166 fully Swing compatible.
167
168
169
170 5. Getting Help
171 ---------------
172 The FAQ is at http://www.jgraph.com/faq.html
173
174 5.1 Documentation
175 -----------------
176 The API specification is included in this distribution and also available at
177 http://api.jgraph.com/. For additional information, updates, binaries and
178 source code see the Home Page of JGraph at http://www.jgraph.com/
179 A complete and up to date User Manual is available at
180 http://www.jgraph.com/downloads.html. The User Manual should be the next
181 document you read after this one.
182
183 5.2 Support
184 -----------
185 Support is available through the Support section of the JGraph
186 web site at http://www.jgraph.com/support.html. On this page the process
187 of finding help is explained. Please note that no free support is provided
188 via email.
189
190 JGraph Developers are available for contract work are reasonable rates.
191 Contact sales (at) jgraph (dot) com for more details.
192
193 A number of more advanced examples at available for purchase from the
194 JGraph web site, see the products section.
195
196 6. Obtaining JGraph
197 -------------------
198 The Home Page of JGraph can be found at http://www.jgraph.com/
199
200 6.1 Binaries
201 ------------
202 The Binaries of JGraph are distributed on
203 http://www.jgraph.com/downloads.html
204
205 6.2 Source code
206 ---------------
207 The sources of JGraph are placed under the LGPL and a commercially oriented
208 license, and the LGPL version is available via anonymous CVS or as zip files
209 via the download link at http://www.jgraph.com/downloads.html.
210
211
212 7. Misc
213 -------
214
215 7.1 Tips and Tricks
216 -------------------
217 To create multiline labels you can use HTML. Here is an example:
218 <html>first line<br>second line</html>
219 The following key bindings are supported by default:
220 o Alt-Drag: Force marquee selection
221 o Shift-Select: Extend selection
222 o Control-Select: Toggle selection
223 o Control-Drag: Clones selection
224 o Shift-Drag: Constrained drag
225 To add and remove bends (edge points) you can press the right mouse button
226 while holding down the Shift key. To use the quadratic and bezier line style
227 the edge must have 1 and 2 intermediate points respectively.
228
229 7.2 Showcase
230 ------------
231 Please send screenshots to info (at) jgraph (dot) com if you would like to
232 see your application on the JGraph web site.
233
234 7.3 Other JGraph packages
235 -------------------------
236 Also available are JGraph Layout Pro and JGraphpad Pro.
237
238 JGraph Layout Pro is a package of commercial-grade layout routines supporting
239 the full range of JGraph features. Layout Pro comes with example applications
240 that demonstrating features such as auto-layout, collapsing/expanding of
241 grouped cells, graph morphing and selective layouting of sub-graphs.
242
243 JGraphpad Pro is a professional implementation of a complete JGraph application
244 framework. It provides a flexible document model and XML-configurable user
245 interface with pluggable actions, tools and custom components. It also provides
246 features such as a palette (library), overview panel (birds-eye view), rich-text
247 data in cells, movable ports, expanding/collapsing, drag and drop and standard
248 XML encoding i/o in a fully-plugable framework architecture.
249
250
251 8. License
252 ----------
253 For legal and licensing issues, please read the LICENSE file.
254 All source and binaries in this package remain copyrighted to Gaudenz Alder.
255
256
257
258 9. Contact Email
259 ----------------
260 Sales sales (at) jgraph (dot) com
261 Commercial Support support (at) jgraph (dot) com
262
263 For more information please visit
264 http://www.jgraph.com/
265
266
267 What's Next?
268 ------------
269
270 Download and read the JGraph User Manual from http://www.jgraph.com/downloads.html.

  ViewVC Help
Powered by ViewVC 1.1.26