jdk/src/share/classes/sun/awt/ConstrainableGraphics.java
author denis
Wed, 27 Mar 2013 16:19:51 +0400
changeset 16705 1caaa379eded
parent 5506 202f599c92aa
permissions -rw-r--r--
7075105: WIN: Provide a way to format HTML on drop Reviewed-by: uta, serb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1998, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package sun.awt;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * This interface can be implemented on a Graphics object to allow
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * the lightweight component code to permanently install a rectangular
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * maximum clip that cannot be extended with setClip and which works in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * conjunction with the hit() and getTransform() methods of Graphics2D
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * to make it appear as if there really was a component with these
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * dimensions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
public interface ConstrainableGraphics {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
     * Constrain this graphics object to have a permanent device space
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
     * origin of (x, y) and a permanent maximum clip of (x,y,w,h).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
     * Calling this method is roughly equivalent to:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
     *    g.translate(x, y);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
     *    g.clipRect(0, 0, w, h);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     * except that the clip can never be extended outside of these
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     * bounds, even with setClip() and for the fact that the (x,y)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
     * become a new device space coordinate origin.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     * These methods are recursive so that you can further restrict
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * the object by calling the constrain() method more times, but
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * you can never enlarge its restricted maximum clip.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    public void constrain(int x, int y, int w, int h);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
}