Class PartialEtchedBorder
- java.lang.Object
-
- javax.swing.border.AbstractBorder
-
- com.inductiveautomation.ignition.common.gui.border.PartialEtchedBorder
-
- All Implemented Interfaces:
java.io.Serializable
,javax.swing.border.Border
public class PartialEtchedBorder extends javax.swing.border.AbstractBorder
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
bottom
protected int
etchType
protected java.awt.Color
highlight
protected boolean
left
static int
LOWERED
Lowered etched type.static int
RAISED
Raised etched type.protected boolean
right
protected java.awt.Color
shadow
protected boolean
top
-
Constructor Summary
Constructors Constructor Description PartialEtchedBorder()
Creates a lowered etched border for the top onlyPartialEtchedBorder(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(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.PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, int etchType, java.awt.Color highlight, java.awt.Color shadow)
Creates an etched border with the specified etch-type, highlight and shadow colors.PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, java.awt.Color highlight, java.awt.Color shadow)
Creates a lowered etched border with the specified highlight and shadow colors.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.awt.Insets
getBorderInsets(java.awt.Component c)
Returns the insets of the border.java.awt.Insets
getBorderInsets(java.awt.Component c, java.awt.Insets insets)
Reinitialize the insets parameter with this Border's current Insets.int
getEtchType()
Returns which etch-type is set on the etched border.java.awt.Color
getHighlightColor()
Returns the highlight color of the etched border.java.awt.Color
getHighlightColor(java.awt.Component c)
Returns the highlight color of the etched border when rendered on the specified component.java.awt.Color
getShadowColor()
Returns the shadow color of the etched border.java.awt.Color
getShadowColor(java.awt.Component c)
Returns the shadow color of the etched border when rendered on the specified component.boolean
isBorderOpaque()
Returns whether or not the border is opaque.void
paintBorder(java.awt.Component c, java.awt.Graphics g, int x, int y, int width, int height)
Paints the border for the specified component with the specified position and size.
-
-
-
Field Detail
-
RAISED
public static final int RAISED
Raised etched type.- See Also:
- Constant Field Values
-
LOWERED
public static final int LOWERED
Lowered etched type.- See Also:
- Constant Field Values
-
etchType
protected int etchType
-
highlight
protected java.awt.Color highlight
-
shadow
protected java.awt.Color shadow
-
top
protected boolean top
-
left
protected boolean left
-
bottom
protected boolean bottom
-
right
protected boolean right
-
-
Constructor Detail
-
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, java.awt.Color highlight, java.awt.Color shadow)
Creates a lowered etched border with the specified highlight and shadow colors.- Parameters:
highlight
- the color to use for the etched highlightshadow
- the color to use for the etched shadow
-
PartialEtchedBorder
public PartialEtchedBorder(boolean top, boolean left, boolean bottom, boolean right, int etchType, java.awt.Color highlight, java.awt.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 borderhighlight
- the color to use for the etched highlightshadow
- the color to use for the etched shadow
-
-
Method Detail
-
paintBorder
public void paintBorder(java.awt.Component c, java.awt.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 interfacejavax.swing.border.Border
- Overrides:
paintBorder
in classjavax.swing.border.AbstractBorder
- Parameters:
c
- the component for which this border is being paintedg
- the paint graphicsx
- the x position of the painted bordery
- the y position of the painted borderwidth
- the width of the painted borderheight
- the height of the painted border
-
getBorderInsets
public java.awt.Insets getBorderInsets(java.awt.Component c)
Returns the insets of the border.- Specified by:
getBorderInsets
in interfacejavax.swing.border.Border
- Overrides:
getBorderInsets
in classjavax.swing.border.AbstractBorder
- Parameters:
c
- the component for which this border insets value applies
-
getBorderInsets
public java.awt.Insets getBorderInsets(java.awt.Component c, java.awt.Insets insets)
Reinitialize the insets parameter with this Border's current Insets.- Overrides:
getBorderInsets
in classjavax.swing.border.AbstractBorder
- Parameters:
c
- the component for which this border insets value appliesinsets
- the object to be reinitialized
-
isBorderOpaque
public boolean isBorderOpaque()
Returns whether or not the border is opaque.- Specified by:
isBorderOpaque
in interfacejavax.swing.border.Border
- Overrides:
isBorderOpaque
in classjavax.swing.border.AbstractBorder
-
getEtchType
public int getEtchType()
Returns which etch-type is set on the etched border.
-
getHighlightColor
public java.awt.Color getHighlightColor(java.awt.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 java.awt.Color getHighlightColor()
Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.
-
getShadowColor
public java.awt.Color getShadowColor(java.awt.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 java.awt.Color getShadowColor()
Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.
-
-