jdk/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthUI.java
author alexsch
Wed, 18 Nov 2015 19:13:42 +0400
changeset 34407 2b40f400a30b
parent 25859 3317bb8137f4
permissions -rw-r--r--
8081411: Add an API for painting an icon with a SynthContext Reviewed-by: serb, azvegint
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4394
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4394
diff changeset
     2
 * Copyright (c) 2002, 2003, Oracle and/or its affiliates. All rights reserved.
4394
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
     4
 *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
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: 4394
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
4394
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4394
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
4394
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    10
 *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    15
 * accompanied this code).
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    16
 *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4394
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4394
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4394
diff changeset
    23
 * questions.
4394
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    24
 */
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    25
package javax.swing.plaf.synth;
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    26
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    27
import java.awt.Graphics;
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    28
import javax.swing.JComponent;
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    29
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    30
/**
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    31
 * SynthUI is used to fetch the SynthContext for a particular Component.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    32
 *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    33
 * @author Scott Violet
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    34
 * @since 1.7
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    35
 */
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    36
public interface SynthUI extends SynthConstants {
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    37
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    38
    /**
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    39
     * Returns the Context for the specified component.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    40
     *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    41
     * @param c Component requesting SynthContext.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    42
     * @return SynthContext describing component.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    43
     */
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    44
    public SynthContext getContext(JComponent c);
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    45
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    46
    /**
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    47
     * Paints the border.
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    48
     *
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    49
     * @param context a component context
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    50
     * @param g {@code Graphics} to paint on
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    51
     * @param x the X coordinate
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    52
     * @param y the Y coordinate
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    53
     * @param w width of the border
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    54
     * @param h height of the border
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    55
     */
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    56
    public void paintBorder(SynthContext context, Graphics g, int x,
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    57
                            int y, int w, int h);
92a8ec883f5d 6827653: Make Synth UI classes public
peterz
parents:
diff changeset
    58
}