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

Contents of /libjgraph-java/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


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

  ViewVC Help
Powered by ViewVC 1.1.26