OpenJDK 27 · javax.swing.border.AbstractBorder · APIdia, the JavaDoc alternative

Access	Constructor and Description
protected	AbstractBorder() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the baseline or < 0 indicating there is no reasonable baseline getBaseline(Component `Component` baseline is being requested for c, int the width to get the baseline for width, int the height to get the baseline for height) Returns the baseline.
public Component.BaselineResizeBehavior	Returns: an enum indicating how the baseline changes as the border is resized getBaselineResizeBehavior(Component `Component` to return baseline resize behavior for c) Returns an enum indicating how the baseline of a component changes as the size changes.
public Insets	Returns: a new `Insets` object getBorderInsets(Component the component for which this border insets value applies c) Implements javax.swing.border.Border.getBorderInsets. This default implementation returns a new `Insets` object that is initialized by the `getBorderInsets(Component, Insets)` method.
public Insets	Returns: the `insets` object getBorderInsets(Component the component for which this border insets value applies c, Insets the object to be reinitialized insets) Reinitializes the insets parameter with this Border's current Insets.
public Rectangle	Returns: a `Rectangle` containing the interior coordinates getInteriorRectangle(Component the component for which this border is being computed c, int the x position of the border x, int the y position of the border y, int the width of the border width, int the height of the border height) This convenience method calls the static method.
public static Rectangle	Returns: a `Rectangle` containing the interior coordinates getInteriorRectangle(Component the component for which this border is being computed c, Border the `Border` object b, int the x position of the border x, int the y position of the border y, int the width of the border width, int the height of the border height) Returns a rectangle using the arguments minus the insets of the border.
public boolean	Returns: false isBorderOpaque() Implements javax.swing.border.Border.isBorderOpaque. This default implementation returns false.
pack-priv static boolean	isLeftToRight(Component c)
public void	paintBorder(Component the component for which this border is being painted c, Graphics the paint graphics g, int the x position of the painted border x, int the y position of the painted border y, int the width of the painted border width, int the height of the painted border height) Implements javax.swing.border.Border.paintBorder. This default implementation does no painting.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AbstractBorder	back to summary
protected AbstractBorder() Constructor for subclasses to call.

Method Detail

getBaseline back to summary

getBaseline	back to summary
public int getBaseline(Component c, int width, int height) Returns the baseline. A return value less than 0 indicates the border does not have a reasonable baseline. The default implementation returns -1. Subclasses that support baseline should override appropriately. If a value >= 0 is returned, then the component has a valid baseline for any size >= the minimum size and `getBaselineResizeBehavior` can be used to determine how the baseline changes with size. Parameters c:Component `Component` baseline is being requested for width:int the width to get the baseline for height:int the height to get the baseline for Returns:int the baseline or < 0 indicating there is no reasonable baseline Exceptions IllegalArgumentException: if width or height is < 0 Since 1.6 See Also `java.awt.Component#getBaseline(int, int)`, `java.awt.Component#getBaselineResizeBehavior()`

public int getBaseline(Component c, int width, int height)

Returns the baseline. A return value less than 0 indicates the border does not have a reasonable baseline.

The default implementation returns -1. Subclasses that support baseline should override appropriately. If a value >= 0 is returned, then the component has a valid baseline for any size >= the minimum size and getBaselineResizeBehavior can be used to determine how the baseline changes with size.

Parameters

c:Component: Component baseline is being requested for
width:int: the width to get the baseline for
height:int: the height to get the baseline for

Returns:int

the baseline or < 0 indicating there is no reasonable baseline

Exceptions

IllegalArgumentException:: if width or height is < 0

Since

1.6

getBaselineResizeBehavior back to summary

getBaselineResizeBehavior	back to summary
public Component.BaselineResizeBehavior getBaselineResizeBehavior(Component c) Returns an enum indicating how the baseline of a component changes as the size changes. This method is primarily meant for layout managers and GUI builders. The default implementation returns `BaselineResizeBehavior.OTHER`, subclasses that support baseline should override appropriately. Subclasses should never return `null`; if the baseline can not be calculated return `BaselineResizeBehavior.OTHER`. Callers should first ask for the baseline using `getBaseline` and if a value >= 0 is returned use this method. It is acceptable for this method to return a value other than `BaselineResizeBehavior.OTHER` even if `getBaseline` returns a value less than 0. Parameters c:Component `Component` to return baseline resize behavior for Returns:Component.BaselineResizeBehavior an enum indicating how the baseline changes as the border is resized Exceptions NullPointerException: if `Component` is `null` Since 1.6 See Also `java.awt.Component#getBaseline(int, int)`, `java.awt.Component#getBaselineResizeBehavior()`

public Component.BaselineResizeBehavior getBaselineResizeBehavior(Component c)

Returns an enum indicating how the baseline of a component changes as the size changes. This method is primarily meant for layout managers and GUI builders.

The default implementation returns BaselineResizeBehavior.OTHER, subclasses that support baseline should override appropriately. Subclasses should never return null; if the baseline can not be calculated return BaselineResizeBehavior.OTHER. Callers should first ask for the baseline using getBaseline and if a value >= 0 is returned use this method. It is acceptable for this method to return a value other than BaselineResizeBehavior.OTHER even if getBaseline returns a value less than 0.

Parameters

c:Component: Component to return baseline resize behavior for

Returns:Component.BaselineResizeBehavior

an enum indicating how the baseline changes as the border is resized

Exceptions

NullPointerException:: if Component is null

Since

1.6

getBorderInsets back to summary

getBorderInsets	back to summary
public Insets getBorderInsets(Component c) Implements javax.swing.border.Border.getBorderInsets. This default implementation returns a new `Insets` object that is initialized by the `getBorderInsets(Component, Insets)` method. By default the `top`, `left`, `bottom`, and `right` fields are set to `0`. Parameters c:Component the component for which this border insets value applies Returns:Insets a new `Insets` object

public Insets getBorderInsets(Component c)

Implements javax.swing.border.Border.getBorderInsets.

This default implementation returns a new Insets object that is initialized by the getBorderInsets(Component, Insets) method. By default the top, left, bottom, and right fields are set to 0.

Parameters

c:Component: the component for which this border insets value applies

Returns:Insets

a new Insets object

getBorderInsets back to summary

getBorderInsets	back to summary
public Insets getBorderInsets(Component c, Insets insets) Reinitializes the insets parameter with this Border's current Insets. Parameters c:Component the component for which this border insets value applies insets:Insets the object to be reinitialized Returns:Insets the `insets` object Exceptions NullPointerException: if the specified `insets` is `null`

public Insets getBorderInsets(Component c, Insets insets)

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

Parameters

c:Component: the component for which this border insets value applies
insets:Insets: the object to be reinitialized

Returns:Insets

the insets object

Exceptions

NullPointerException:: if the specified insets is null

getInteriorRectangle back to summary

getInteriorRectangle	back to summary
public Rectangle getInteriorRectangle(Component c, int x, int y, int width, int height) This convenience method calls the static method. Parameters c:Component the component for which this border is being computed x:int the x position of the border y:int the y position of the border width:int the width of the border height:int the height of the border Returns:Rectangle a `Rectangle` containing the interior coordinates

public Rectangle getInteriorRectangle(Component c, int x, int y, int width, int height)

This convenience method calls the static method.

Parameters

c:Component: the component for which this border is being computed
x:int: the x position of the border
y:int: the y position of the border
width:int: the width of the border
height:int: the height of the border

Returns:Rectangle

a Rectangle containing the interior coordinates

getInteriorRectangle back to summary

getInteriorRectangle	back to summary
public static Rectangle getInteriorRectangle(Component c, Border b, int x, int y, int width, int height) Returns a rectangle using the arguments minus the insets of the border. This is useful for determining the area that components should draw in that will not intersect the border. Parameters c:Component the component for which this border is being computed b:Border the `Border` object x:int the x position of the border y:int the y position of the border width:int the width of the border height:int the height of the border Returns:Rectangle a `Rectangle` containing the interior coordinates

public static Rectangle getInteriorRectangle(Component c, Border b, int x, int y, int width, int height)

Returns a rectangle using the arguments minus the insets of the border. This is useful for determining the area that components should draw in that will not intersect the border.

Parameters

c:Component: the component for which this border is being computed
b:Border: the Border object
x:int: the x position of the border
y:int: the y position of the border
width:int: the width of the border
height:int: the height of the border

Returns:Rectangle

a Rectangle containing the interior coordinates

isBorderOpaque	back to summary
public boolean isBorderOpaque() Implements javax.swing.border.Border.isBorderOpaque. This default implementation returns false. Returns:boolean false

isBorderOpaque

back to summary

public boolean isBorderOpaque()

Implements javax.swing.border.Border.isBorderOpaque.

This default implementation returns false.

Returns:boolean: false

isLeftToRight	back to summary
pack-priv static boolean isLeftToRight(Component c)

paintBorder	back to summary
public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) Implements javax.swing.border.Border.paintBorder. This default implementation does no painting. Parameters c:Component the component for which this border is being painted g:Graphics the paint graphics x:int the x position of the painted border y:int the y position of the painted border width:int the width of the painted border height:int the height of the painted border

paintBorder

back to summary

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

Implements javax.swing.border.Border.paintBorder.

This default implementation does no painting.

Parameters

c:Component: the component for which this border is being painted
g:Graphics: the paint graphics
x:int: the x position of the painted border
y:int: the y position of the painted border
width:int: the width of the painted border
height:int: the height of the painted border

public abstract Class AbstractBorder

Constructor Summary

Method Summary

Constructor Detail

Method Detail