public class

MatteBorder

extends EmptyBorder
java.lang.Object
   ↳ javax.swing.border.AbstractBorder
     ↳ javax.swing.border.EmptyBorder
       ↳ javax.swing.border.MatteBorder
Known Direct Subclasses

Class Overview

A class which provides a matte-like border of either a solid color or a tiled icon.

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.

Summary

Fields
protected Color color
protected Icon tileIcon
[Expand]
Inherited Fields
From class javax.swing.border.EmptyBorder
Public Constructors
MatteBorder(int top, int left, int bottom, int right, Color matteColor)
Creates a matte border with the specified insets and color.
MatteBorder(Insets borderInsets, Color matteColor)
Creates a matte border with the specified insets and color.
MatteBorder(int top, int left, int bottom, int right, Icon tileIcon)
Creates a matte border with the specified insets and tile icon.
MatteBorder(Insets borderInsets, Icon tileIcon)
Creates a matte border with the specified insets and tile icon.
MatteBorder(Icon tileIcon)
Creates a matte border with the specified tile icon.
Public Methods
Insets getBorderInsets()
Returns the insets of the border.
Insets getBorderInsets(Component c, Insets insets)
Reinitialize the insets parameter with this Border's current Insets.
Insets getBorderInsets(Component c)
Returns the insets of the border.
Color getMatteColor()
Returns the color used for tiling the border or null if a tile icon is being used.
Icon getTileIcon()
Returns the icon used for tiling the border or null if a solid color is being used.
boolean isBorderOpaque()
Returns whether or not the border is opaque.
void paintBorder(Component c, Graphics g, int x, int y, int width, int height)
Paints the matte border.
[Expand]
Inherited Methods
From class javax.swing.border.EmptyBorder
From class javax.swing.border.AbstractBorder
From class java.lang.Object
From interface javax.swing.border.Border

Fields

protected Color color

protected Icon tileIcon

Public Constructors

public MatteBorder (int top, int left, int bottom, int right, Color matteColor)

Creates a matte border with the specified insets and color.

Parameters
top the top inset of the border
left the left inset of the border
bottom the bottom inset of the border
right the right inset of the border
matteColor the color rendered for the border

public MatteBorder (Insets borderInsets, Color matteColor)

Creates a matte border with the specified insets and color.

Parameters
borderInsets the insets of the border
matteColor the color rendered for the border

public MatteBorder (int top, int left, int bottom, int right, Icon tileIcon)

Creates a matte border with the specified insets and tile icon.

Parameters
top the top inset of the border
left the left inset of the border
bottom the bottom inset of the border
right the right inset of the border
tileIcon the icon to be used for tiling the border

public MatteBorder (Insets borderInsets, Icon tileIcon)

Creates a matte border with the specified insets and tile icon.

Parameters
borderInsets the insets of the border
tileIcon the icon to be used for tiling the border

public MatteBorder (Icon tileIcon)

Creates a matte border with the specified tile icon. The insets will be calculated dynamically based on the size of the tile icon, where the top and bottom will be equal to the tile icon's height, and the left and right will be equal to the tile icon's width.

Parameters
tileIcon the icon to be used for tiling the border

Public Methods

public Insets getBorderInsets ()

Returns the insets of the border.

public Insets getBorderInsets (Component c, Insets insets)

Reinitialize the insets parameter with this Border's current Insets.

Parameters
c the component for which this border insets value applies
insets the object to be reinitialized
Returns
  • the insets object

public Insets getBorderInsets (Component c)

Returns the insets of the border.

Parameters
c the component for which this border insets value applies
Returns
  • the new Insets object initialized to 0

public Color getMatteColor ()

Returns the color used for tiling the border or null if a tile icon is being used.

public Icon getTileIcon ()

Returns the icon used for tiling the border or null if a solid color is being used.

public boolean isBorderOpaque ()

Returns whether or not the border is opaque.

Returns
  • false

public void paintBorder (Component c, Graphics g, int x, int y, int width, int height)

Paints the matte border.

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