StyleAndAnimationBorder.java
package swingtree.style;
import org.jspecify.annotations.Nullable;
import org.slf4j.Logger;
import swingtree.UI;
import swingtree.api.Styler;
import javax.swing.AbstractButton;
import javax.swing.JComponent;
import javax.swing.border.Border;
import javax.swing.text.JTextComponent;
import java.awt.*;
/**
* A custom {@link Border} implementation which is capable of painting large parts of
* the styles exposed by the style API (see {@link swingtree.UIForAnySwing#withStyle(Styler)})
* as well as the previously installed {@link Border} of a component,
* to which it delegates the painting of the border if the current {@link StyleConf}
* does not override the looks of the former border.
* Not only does this paint borders, shadows and animation lambda, but it also
* calculates the border insets of the component based on the margins, paddings and border widths
* specified by the user of the style API. <br>
* This class is mostly responsible for making styling compatible with
* any plain old Swing component...
*
* @param <C> The type of the component that is being styled, animated or sized in a particular way...
*/
final class StyleAndAnimationBorder<C extends JComponent> implements Border
{
private static final Logger log = org.slf4j.LoggerFactory.getLogger(StyleAndAnimationBorder.class);
private final ComponentExtension<C> _compExt;
private final Border _formerBorder;
private final boolean _borderWasNotPainted;
private @Nullable Insets _insets;
private final Insets _marginInsets = new Insets(0, 0, 0, 0);
private final Insets _paddingInsets = new Insets(0, 0, 0, 0);
private final Insets _fullPaddingInsets = new Insets(0, 0, 0, 0);
StyleAndAnimationBorder( ComponentExtension<C> compExt, Border formerBorder, StyleConf styleConf) {
_compExt = compExt;
_insets = null;
_formerBorder = formerBorder;
if ( _compExt.getOwner() instanceof AbstractButton ) {
AbstractButton b = (AbstractButton) _compExt.getOwner();
_borderWasNotPainted = !b.isBorderPainted();
if ( !b.isBorderPainted() )
b.setBorderPainted(true);
}
else
_borderWasNotPainted = false;
}
Border getFormerBorder() { return _formerBorder; }
Insets getMarginInsets() { return _marginInsets; }
Insets getPaddingInsets() { return _paddingInsets; }
Insets getFullPaddingInsets() { return _fullPaddingInsets; }
@Override
public void paintBorder( Component c, Graphics graphics, int x, int y, int width, int height )
{
try {
_compExt.paintBorder((Graphics2D) graphics, localGraphics->{
if ( _canPaintFormerBorder() )
_paintFormerBorder(c, localGraphics, x, y, width, height);
});
} catch ( Exception ex ) {
/*
Note that if any exceptions happen during the border style painting,
then we don't want to mess up how the rest of the component is painted...
Therefore, we catch any exceptions that happen in the above code.
*/
log.error("Exception while painting border style '"+_compExt.getStyle().border()+"': ", ex);
}
}
private boolean _canPaintFormerBorder() {
if ( _formerBorder != null && !_borderWasNotPainted ) {
BorderConf borderConf = _compExt.getStyle().border();
if ( !borderConf.isVisible() )
return true;
}
return false;
}
private boolean _canUseFormerBorderInsets() {
if ( _formerBorder != null ) {
BorderConf borderConf = _compExt.getStyle().border();
if ( !borderConf.isVisible() )
return true;
}
return false;
}
private void _paintFormerBorder( Component c, Graphics g, int x, int y, int width, int height ) {
try {
x = x + _marginInsets.left;
y = y + _marginInsets.top;
width = width - _marginInsets.left - _marginInsets.right;
height = height - _marginInsets.top - _marginInsets.bottom;
_formerBorder.paintBorder(c, g, x, y, width, height);
}
catch (Exception ex)
{
ex.printStackTrace();
/*
Note that if any exceptions happen in the former Border implementation,
then we don't want to mess up the execution of the rest of the component painting...
Therefore, we catch any exceptions that happen in the above code.
Ideally this would be logged in the logging framework of the user
who implemented the Border,
but we don't know which logging framework that is, so we just print
the stack trace to the console so that any developers can see what went wrong.
*/
log.error("Exception while painting former border '{}': ", _formerBorder, ex);
}
}
@Override
public Insets getBorderInsets( Component c ) {
if ( _insets == null )
_compExt.gatherApplyAndInstallStyle(false);
if ( _insets == null )
return new Insets(0, 0, 0, 0);
else
return _insets;
}
void recalculateInsets(StyleConf styleConf)
{
_calculateMarginInsets(styleConf);
_calculatePaddingInsets(styleConf);
_calculateFullPaddingInsets(styleConf);
_calculateBorderInsets(styleConf);
}
@Override
public boolean isBorderOpaque() { return false; }
private boolean _doesNotDelegateAdditionalInsets() {
if ( !_canUseFormerBorderInsets() )
return true;
if ( _formerBorder == null )
return true;
boolean usesSwingTreeBorder = _compExt.getStyle().border().isVisible();
if ( usesSwingTreeBorder )
return true;
return false;
}
public Outline getDelegatedInsets( StyleConf conf )
{
if ( _doesNotDelegateAdditionalInsets() )
return Outline.of(0, 0, 0, 0);
else
{
Insets formerInsets = _formerBorder.getBorderInsets(_compExt.getOwner());
return conf.padding().map(v->0f).or(Outline.of(formerInsets));
}
}
public Outline getDelegatedInsetsComponentAreaCorrection()
{
if ( _doesNotDelegateAdditionalInsets() )
return Outline.of(0, 0, 0, 0);
else
{
if (
UI.currentLookAndFeel().isOneOf(UI.LookAndFeel.NIMBUS) &&
_compExt.getOwner() instanceof JTextComponent
) {
Insets formerInsets = _formerBorder.getBorderInsets(_compExt.getOwner());
int left = formerInsets.left / 2;
int top = formerInsets.top / 2;
int right = formerInsets.right / 2;
int bottom = formerInsets.bottom / 2;
return Outline.of(top, right, bottom, left);
}
return Outline.of(0, 0, 0, 0);
}
}
private void _calculateBorderInsets( StyleConf styleConf )
{
// Margin:
float left = styleConf.margin().left() .orElse(0f);
float top = styleConf.margin().top() .orElse(0f);
float right = styleConf.margin().right() .orElse(0f);
float bottom = styleConf.margin().bottom().orElse(0f);
// Add border widths:
left += Math.max(styleConf.border().widths().left().orElse(0f), 0);
top += Math.max(styleConf.border().widths().top().orElse(0f), 0);
right += Math.max(styleConf.border().widths().right().orElse(0f), 0);
bottom += Math.max(styleConf.border().widths().bottom().orElse(0f), 0);
// Add padding:
left += styleConf.padding().left().orElse(0f);
top += styleConf.padding().top().orElse(0f);
right += styleConf.padding().right().orElse(0f);
bottom += styleConf.padding().bottom().orElse(0f);
if (
_insets == null ||
_insets.left != left ||
_insets.top != top ||
_insets.right != right ||
_insets.bottom != bottom
) {
if ( _insets == null )
_insets = new Insets((int) top, (int) left, (int) bottom, (int) right);
else
_insets.set((int) top, (int) left, (int) bottom, (int) right);
_compExt.getOwner().revalidate();
}
}
private void _calculateMarginInsets( StyleConf styleConf )
{
float left = styleConf.margin().left().orElse(0f);
float top = styleConf.margin().top().orElse(0f);
float right = styleConf.margin().right().orElse(0f);
float bottom = styleConf.margin().bottom().orElse(0f);
// Add border widths:
left += Math.max(styleConf.border().widths().left().orElse(0f), 0);
top += Math.max(styleConf.border().widths().top().orElse(0f), 0);
right += Math.max(styleConf.border().widths().right().orElse(0f), 0);
bottom += Math.max(styleConf.border().widths().bottom().orElse(0f), 0);
_marginInsets.top = (int) top;
_marginInsets.left = (int) left;
_marginInsets.right = (int) right;
_marginInsets.bottom = (int) bottom;
}
private void _calculatePaddingInsets( StyleConf styleConf)
{
_paddingInsets.top = styleConf.padding().top().map(Number::intValue).orElse(0);
_paddingInsets.left = styleConf.padding().left().map(Number::intValue).orElse(0);
_paddingInsets.right = styleConf.padding().right().map(Number::intValue).orElse(0);
_paddingInsets.bottom = styleConf.padding().bottom().map(Number::intValue).orElse(0);
}
private void _calculateFullPaddingInsets( StyleConf styleConf)
{
_fullPaddingInsets.top = (int)( styleConf.padding().top().orElse(0f) + styleConf.margin().top().orElse(0f) );
_fullPaddingInsets.left = (int)( styleConf.padding().left().orElse(0f) + styleConf.margin().left().orElse(0f) );
_fullPaddingInsets.right = (int)( styleConf.padding().right().orElse(0f) + styleConf.margin().right().orElse(0f) );
_fullPaddingInsets.bottom = (int)( styleConf.padding().bottom().orElse(0f) + styleConf.margin().bottom().orElse(0f) );
}
}