Package com.inductiveautomation.ignition.common.gui.border

Class PartialEtchedBorder

java.lang.Object
javax.swing.border.AbstractBorder
com.inductiveautomation.ignition.common.gui.border.PartialEtchedBorder
All Implemented Interfaces:
Serializable, Border
public class PartialEtchedBorder extends AbstractBorder
See Also:

  • Field Details

    • RAISED

      public static final int RAISED
      Raised etched type.
      See Also:

    • LOWERED

      public static final int LOWERED
      Lowered etched type.
      See Also:

    • etchType

      protected int etchType

    • highlight

      protected Color highlight

    • shadow

      protected Color shadow

    • top

      protected boolean top

    • left

      protected boolean left

    • bottom

      protected boolean bottom

  • Constructor Details

    • PartialEtchedBorder

      public PartialEtchedBorder()
      Creates a lowered etched border for the top only

    • PartialEtchedBorder

      public PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right)
      Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.

    • PartialEtchedBorder

      public PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, 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

    • PartialEtchedBorder

      public PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, 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

    • PartialEtchedBorder

      public PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, 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 Details

    • 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)
      Returns the insets of the border.
      Specified by:
      getBorderInsets in interface Border
      Overrides:
      getBorderInsets in class AbstractBorder
      Parameters:
      c - the component for which this border insets value applies

    • 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

    • isBorderOpaque

      public boolean isBorderOpaque()
      Returns whether or not the border is opaque.
      Specified by:
      isBorderOpaque in interface Border
      Overrides:
      isBorderOpaque in class AbstractBorder

    • 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

    • getHighlightColor

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

    • 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

    • getShadowColor

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