public class IconBorder extends Object implements Border, Serializable
IconBorder
creates a border that places an Icon
in the border
on the horizontal axis. The border does not add any additional insets other
than the inset required to produce the space for the icon. If additional
insets are required, users should create a
compund border
.
This border is useful when attempting to add Icon
s to pre-existing
components without requiring specialty painting.
Modifier and Type | Field and Description |
---|---|
static Icon |
EMPTY_ICON
An empty icon.
|
private Icon |
icon |
private Rectangle |
iconBounds |
private int |
iconPosition |
private int |
padding |
Constructor and Description |
---|
IconBorder()
Creates an
IconBorder with an empty icon in a trailing position
with a padding of 4. |
IconBorder(Icon validIcon)
Creates an
IconBorder with the specified icon in a trailing
position with a padding of 4. |
IconBorder(Icon validIcon,
int iconPosition)
Creates an
IconBorder with the specified constraints and a
padding of 4. |
IconBorder(Icon validIcon,
int iconPosition,
int padding)
Creates an
IconBorder with the specified constraints. |
Modifier and Type | Method and Description |
---|---|
private int |
bidiDecodeLeadingTrailing(ComponentOrientation c,
int position)
Returns EAST or WEST depending on the ComponentOrientation and
the given postion LEADING/TRAILING this method has no effect for other
position values
|
Insets |
getBorderInsets(Component c) |
int |
getIconPosition()
Returns the position to place the icon (relative to the component contents).
|
int |
getPadding()
Gets the padding surrounding the icon.
|
boolean |
isBorderOpaque()
This border is not opaque.
|
private boolean |
isValidPosition(int position) |
void |
paintBorder(Component c,
Graphics g,
int x,
int y,
int width,
int height) |
void |
setIcon(Icon validIcon)
Sets the icon for this border.
|
void |
setIconPosition(int iconPosition)
Sets the position to place the icon (relative to the component contents).
|
void |
setPadding(int padding)
Sets the padding around the icon.
|
public static final Icon EMPTY_ICON
private int padding
private int iconPosition
private Rectangle iconBounds
public IconBorder()
IconBorder
with an empty icon in a trailing position
with a padding of 4.EMPTY_ICON
public IconBorder(Icon validIcon)
IconBorder
with the specified icon in a trailing
position with a padding of 4.validIcon
- the icon to set. This may be null
to represent an
empty icon.EMPTY_ICON
public IconBorder(Icon validIcon, int iconPosition)
IconBorder
with the specified constraints and a
padding of 4.validIcon
- the icon to set. This may be null
to represent an
empty icon.iconPosition
- the position to place the icon relative to the component
contents. This must be one of the following
SwingConstants
:
LEADING
TRAILING
EAST
WEST
IllegalArgumentException
- if iconPosition
is not a valid position.EMPTY_ICON
public IconBorder(Icon validIcon, int iconPosition, int padding)
IconBorder
with the specified constraints. If
validIcon
is null
, EMPTY_ICON
is used instead.
If padding
is negative, then the border does not use padding.validIcon
- the icon to set. This may be null
to represent an
empty icon.iconPosition
- the position to place the icon relative to the component
contents. This must be one of the following
SwingConstants
:
LEADING
TRAILING
EAST
WEST
padding
- the padding to surround the icon with. All non-positive values
set the padding to 0.IllegalArgumentException
- if iconPosition
is not a valid position.EMPTY_ICON
private boolean isValidPosition(int position)
public Insets getBorderInsets(Component c)
getBorderInsets
in interface Border
public void setIcon(Icon validIcon)
validIcon
- the icon to set. This may be null
to represent an
empty icon.EMPTY_ICON
public boolean isBorderOpaque()
isBorderOpaque
in interface Border
false
public void paintBorder(Component c, Graphics g, int x, int y, int width, int height)
paintBorder
in interface Border
private int bidiDecodeLeadingTrailing(ComponentOrientation c, int position)
public int getPadding()
public void setPadding(int padding)
padding
- the padding to set. If padding < 0
, then
padding
will be set to 0
.public int getIconPosition()
SwingConstants
:
LEADING
TRAILING
EAST
WEST
public void setIconPosition(int iconPosition)
iconPosition
- must be one of the following SwingConstants
:
LEADING
TRAILING
EAST
WEST
IllegalArgumentException
- if iconPosition
is not a valid position.WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses