blob: 04ff054c19e42ae175e8f428b82c15b720b9f77a [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 1998 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package sun.awt;
27
28/**
29 * This interface can be implemented on a Graphics object to allow
30 * the lightweight component code to permanently install a rectangular
31 * maximum clip that cannot be extended with setClip and which works in
32 * conjunction with the hit() and getTransform() methods of Graphics2D
33 * to make it appear as if there really was a component with these
34 * dimensions.
35 */
36public interface ConstrainableGraphics {
37 /**
38 * Constrain this graphics object to have a permanent device space
39 * origin of (x, y) and a permanent maximum clip of (x,y,w,h).
40 * Calling this method is roughly equivalent to:
41 * g.translate(x, y);
42 * g.clipRect(0, 0, w, h);
43 * except that the clip can never be extended outside of these
44 * bounds, even with setClip() and for the fact that the (x,y)
45 * become a new device space coordinate origin.
46 *
47 * These methods are recursive so that you can further restrict
48 * the object by calling the constrain() method more times, but
49 * you can never enlarge its restricted maximum clip.
50 */
51 public void constrain(int x, int y, int w, int h);
52}