de JComboBox Renderer

Die nachfolgende Abbildung stellt die plattformübergreifende Metal L&F mit den Themen OCEAN und STEEL und andere UI-Implementierungen von JComboBox gegenüber. Die Klappliste ist in der Darstellung nicht zu sehen:

Wo findet man den Renderer für JComboBox und die Klappliste? Notfalls per Debugger.

// in JComboBox ctor wird via init() die UI angepasst:
    private void init() {
        installAncestorListener();
        setUIProperty("opaque",true);
        updateUI(); // <============
    }
    
    public void updateUI() {
    ...
            try {
                setUI((ComboBoxUI)UIManager.getUI(this));  // getUI liefert je nach Einstellung
                // MetalComboBoxUI für Metal bzw. SynthComboBoxUI für Nimbus
    ...
    }

    public void setUI(ComboBoxUI ui) {
        super.setUI(ui);  // <============ JComponent.setUI
    }

In JComponent.setUI geht es weiter je nach Umgebung (hier Metal UI):

    protected void setUI(ComponentUI newUI) {
        ...
        ui = newUI;
        if (ui != null) {
            ui.installUI(this);  // <== this=javax.swing.plaf.metal.MetalComboBoxUI
            // MetalComboBoxUI hat installUI von BasicComboBoxUI nicht überschrieben ...
        }
        ...
    }

    // also weiter in BasicComboBoxUI.installUI
    public void installUI( JComponent c ) {
        ...
        if ( comboBox.getRenderer() == null || comboBox.getRenderer() instanceof UIResource ) {
            comboBox.setRenderer( createRenderer() );  // <============ 
        }
        ...
    }

    protected ListCellRenderer<Object> createRenderer() {
        return new BasicComboBoxRenderer.UIResource(); // !!! gefunden
    }

In Nimbus UI ist es anders:

    protected void setUI(ComponentUI newUI) {
        ...
        ui = newUI;
        if (ui != null) {
            ui.installUI(this);  // <== this=javax.swing.plaf.synth.SynthComboBoxUI
        }
        ...
    }
    
    // SynthComboBoxUI.installUI :
    public void installUI(JComponent c) {
        buttonHandler = new ButtonHandler();
        super.installUI(c);
    }

    // und superclass BasicComboBoxUI.installUI
    public void installUI( JComponent c ) {
        ...
        if ( comboBox.getRenderer() == null || comboBox.getRenderer() instanceof UIResource ) {
            comboBox.setRenderer( createRenderer() );  // <============ 
        }
        ...
    }

    protected ListCellRenderer<Object> createRenderer() {
        return new SynthComboBoxRenderer();  // !!! gefunden
    }

Renderer

Der Renderer ist also je nach UI implementiert

• in inner private class SynthComboBoxUI.SynthComboBoxRenderer extends JLabel für Nimbus (wg. private kann man den Renderer nicht so einfach erweitern) bzw.
• in inner public static class BasicComboBoxRenderer.UIResource für Metal. Dort ist aber nichts implementiert:

    public static class UIResource extends BasicComboBoxRenderer 
                                   implements javax.swing.plaf.UIResource {
        public UIResource() {}
    }

Also ist javax.swing.plaf.basic.BasicComboBoxRenderer die default Implementierung für Metal. Und die ist nichts anderes als ein JButton mit Text und etwas Gedöns drumrum:

public class BasicComboBoxRenderer extends JLabel ... {
    protected static Border noFocusBorder = new EmptyBorder(1, 1, 1, 1);
    public BasicComboBoxRenderer() {
        super();
        setOpaque(true);
        setBorder(getNoFocusBorder());
    }
    ...

Nimbus Renderer erweitern

Wie schon oben angedeutet, kann man den Nimbus Renderer nicht so einfach erweitern, weil er als inner private class SynthComboBoxUI.SynthComboBoxRenderer implementiert ist. Auch die createUI ist in SynthComboBoxUI. Daher erweitere ich die ganze UI-Klasse:

public class SynthYComboBoxUI extends SynthComboBoxUI {

    private static final Logger LOG = Logger.getLogger(SynthYComboBoxUI.class.getName());

    public SynthYComboBoxUI() {
        super();
    }

    // Creates a new UI object for the given component. Like in SynthComboBoxUI
    public static ComponentUI createUI(JComponent c) {
        return new SynthYComboBoxUI();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected ListCellRenderer<Object> createRenderer() {
        return new SynthYComboBoxRenderer();
    }

    // SynthComboBoxUI.SynthComboBoxRenderer is private
    @SuppressWarnings("serial") // Superclass is not serializable across versions
    public class SynthYComboBoxRenderer extends JLabel implements ListCellRenderer<Object>, UIResource {
    ...

Die UI wird in JComboBox#updateUI() gesetzt. Statt die ganze Methode zu überschreiben, genügt

public class JYComboBox<E> extends JComboBox<E> {

    private static final Logger LOG = Logger.getLogger(JYComboBox.class.getName());

    public JYComboBox(E[] items) {
        super(items);
    }

    public void setUI(ComboBoxUI ui) {
        LOG.info("ui:"+ui);
        UIDefaults uidHashtable = UIManager.getDefaults();
        uidHashtable.put("ComboBoxUI", "samples.plaf.synth.SynthYComboBoxUI");
        uidHashtable.put("ComboBox.padding", new InsetsUIResource(10, 10, 10, 10));
//        ComponentUI cui = SynthYComboBoxUI.createUI(this);
        ComponentUI cui = UIManager.getUI(this);
        if (cui instanceof ComboBoxUI cbui) {
            super.setUI(cbui);
        } else {
            super.setUI(ui);
        }
    }
...