javax.swing.border

Class EtchedBorder

Contents
  • All Implemented Interfaces:
    Serializable, Border
    Direct Known Subclasses:
    BorderUIResource.EtchedBorderUIResource

    public class EtchedBorder
extends AbstractBorder
    A class which implements a simple etched border which can either be etched-in or etched-out. If no highlight/shadow colors are initialized when the border is created, then these colors will be dynamically derived from the background color of the component argument passed into the paintBorder() method.

    Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

    • Field Detail

      • etchType

        protected int etchType

      • highlight

        protected Color highlight

      • shadow

        protected Color shadow

    • Constructor Detail

      • EtchedBorder

        public EtchedBorder()
        Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.

      • EtchedBorder

        public EtchedBorder(int etchType)
        Creates an etched border with the specified etch-type whose colors will be derived from the background color of the component passed into the paintBorder method.
        Parameters:
        etchType - the type of etch to be drawn by the border

      • EtchedBorder

        public EtchedBorder(Color highlight,
            Color shadow)
        Creates a lowered etched border with the specified highlight and shadow colors.
        Parameters:
        highlight - the color to use for the etched highlight
        shadow - the color to use for the etched shadow

      • EtchedBorder

        @ConstructorProperties(value={"etchType","highlightColor","shadowColor"})
public EtchedBorder(int etchType,
                                       Color highlight,
                                       Color shadow)
        Creates an etched border with the specified etch-type, highlight and shadow colors.
        Parameters:
        etchType - the type of etch to be drawn by the border
        highlight - the color to use for the etched highlight
        shadow - the color to use for the etched shadow

    • Method Detail

      • paintBorder

        public void paintBorder(Component c,
               Graphics g,
               int x,
               int y,
               int width,
               int height)
        Paints the border for the specified component with the specified position and size.
        Specified by:
        paintBorder in interface Border
        Overrides:
        paintBorder in class AbstractBorder
        Parameters:
        c - the component for which this border is being painted
        g - the paint graphics
        x - the x position of the painted border
        y - the y position of the painted border
        width - the width of the painted border
        height - the height of the painted border

      • getBorderInsets

        public Insets getBorderInsets(Component c,
                     Insets insets)
        Reinitialize the insets parameter with this Border's current Insets.
        Overrides:
        getBorderInsets in class AbstractBorder
        Parameters:
        c - the component for which this border insets value applies
        insets - the object to be reinitialized
        Returns:
        the insets object

      • getEtchType

        public int getEtchType()
        Returns which etch-type is set on the etched border.

      • getHighlightColor

        public Color getHighlightColor(Component c)
        Returns the highlight color of the etched border when rendered on the specified component. If no highlight color was specified at instantiation, the highlight color is derived from the specified component's background color.
        Parameters:
        c - the component for which the highlight may be derived
        Since:
        1.3

      • getHighlightColor

        public Color getHighlightColor()
        Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.
        Since:
        1.3

      • getShadowColor

        public Color getShadowColor(Component c)
        Returns the shadow color of the etched border when rendered on the specified component. If no shadow color was specified at instantiation, the shadow color is derived from the specified component's background color.
        Parameters:
        c - the component for which the shadow may be derived
        Since:
        1.3

      • getShadowColor

        public Color getShadowColor()
        Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.
        Since:
        1.3

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/border/EtchedBorder.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut