~ubuntu-branches/ubuntu/saucy/libtggraphlayout-java/saucy

« back to all changes in this revision

Viewing changes to com/touchgraph/graphlayout/TGScrollPane.java

  • Committer: Bazaar Package Importer
  • Author(s): Morten Sørensen
  • Date: 2009-12-06 17:57:32 UTC
  • Revision ID: james.westby@ubuntu.com-20091206175732-auvd39j1u30e0x50
Tags: upstream-122
Import upstream version 122

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * TouchGraph LLC. Apache-Style Software License
 
3
 *
 
4
 *
 
5
 * Copyright (c) 2001-2002 Alexander Shapiro. All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions
 
9
 * are met:
 
10
 *
 
11
 * 1. Redistributions of source code must retain the above copyright
 
12
 *    notice, this list of conditions and the following disclaimer. 
 
13
 *
 
14
 * 2. Redistributions in binary form must reproduce the above copyright
 
15
 *    notice, this list of conditions and the following disclaimer in
 
16
 *    the documentation and/or other materials provided with the
 
17
 *    distribution.
 
18
 *
 
19
 * 3. The end-user documentation included with the redistribution,
 
20
 *    if any, must include the following acknowledgment:  
 
21
 *       "This product includes software developed by 
 
22
 *        TouchGraph LLC (http://www.touchgraph.com/)."
 
23
 *    Alternately, this acknowledgment may appear in the software itself,
 
24
 *    if and wherever such third-party acknowledgments normally appear.
 
25
 *
 
26
 * 4. The names "TouchGraph" or "TouchGraph LLC" must not be used to endorse 
 
27
 *    or promote products derived from this software without prior written 
 
28
 *    permission.  For written permission, please contact 
 
29
 *    alex@touchgraph.com
 
30
 *
 
31
 * 5. Products derived from this software may not be called "TouchGraph",
 
32
 *    nor may "TouchGraph" appear in their name, without prior written
 
33
 *    permission of alex@touchgraph.com.
 
34
 *
 
35
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 
36
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 
37
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 
38
 * DISCLAIMED.  IN NO EVENT SHALL TOUCHGRAPH OR ITS CONTRIBUTORS BE 
 
39
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 
40
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 
41
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
 
42
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 
43
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 
44
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 
45
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
46
 * ====================================================================
 
47
 *
 
48
 */
 
49
 
 
50
package com.touchgraph.graphlayout;
 
51
 
 
52
import  com.touchgraph.graphlayout.interaction.*;
 
53
 
 
54
import  java.awt.Point;
 
55
 
 
56
/** TGScrollPane is a Java interface for a user interface using scrollbars
 
57
  * to set TouchGraph navigation and editing properties such as zoom, rotate
 
58
  * and locality. If a particular UI doesn't use a specific scrollbar, the 
 
59
  * corresponding method should return a null.
 
60
  *
 
61
  * @author   Murray Altheim  
 
62
  * @author   Alex Shapiro
 
63
  * @version  1.22-jre1.1  $Id: TGScrollPane.java,v 1.1 2002/09/19 15:58:08 ldornbusch Exp $
 
64
  */
 
65
public interface TGScrollPane {
 
66
 
 
67
    /** Return the TGPanel used with this TGScrollPane. */
 
68
    public TGPanel getTGPanel();
 
69
 
 
70
  // navigation .................
 
71
 
 
72
    /** Return the HVScroll used with this TGScrollPane. */
 
73
    public HVScroll getHVScroll();
 
74
 
 
75
    /** Return the HyperScroll used with this TGScrollPane. */
 
76
    public HyperScroll getHyperScroll();
 
77
 
 
78
    /** Sets the horizontal offset to p.x, and the vertical offset to p.y
 
79
      * given a Point <tt>p<tt>. 
 
80
      */
 
81
    public void setOffset( Point p );
 
82
 
 
83
    /** Return the horizontal and vertical offset position as a Point. */
 
84
    public Point getOffset();
 
85
 
 
86
  // rotation ...................
 
87
 
 
88
    /** Return the RotateScroll used with this TGScrollPane. */
 
89
    public RotateScroll getRotateScroll();
 
90
 
 
91
    /** Set the rotation angle of this TGScrollPane (allowable values between 0 to 359). */
 
92
     public void setRotationAngle( int angle );
 
93
 
 
94
    /** Return the rotation angle of this TGScrollPane. */
 
95
    public int getRotationAngle();
 
96
 
 
97
  // locality ...................
 
98
 
 
99
    /** Return the LocalityScroll used with this TGScrollPane. */
 
100
    public LocalityScroll getLocalityScroll();
 
101
 
 
102
    /** Set the locality radius of this TGScrollPane  
 
103
      * (allowable values between 0 to 4, or LocalityUtils.INFINITE_LOCALITY_RADIUS). 
 
104
      */
 
105
    public void setLocalityRadius( int radius );
 
106
 
 
107
    /** Return the locality radius of this TGScrollPane. */
 
108
    public int getLocalityRadius();
 
109
 
 
110
  // zoom .......................
 
111
 
 
112
    /** Return the ZoomScroll used with this TGScrollPane. */
 
113
    public ZoomScroll getZoomScroll();
 
114
 
 
115
    /** Set the zoom value of this TGScrollPane (allowable values between -100 to 100). */
 
116
    public void setZoomValue( int zoomValue );
 
117
 
 
118
    /** Return the zoom value of this TGScrollPane. */
 
119
    public int getZoomValue();
 
120
 
 
121
} // end com.touchgraph.graphlayout.TGScrollPane