Компонент Java не отображается при запуске

Ваша проблема вызвана изменением фабрики пользовательского интерфейса на JTextField (это вызвано установкой Nimbus L & F и updateComponentTreeUI()).

Когда вы выполняете второй вызов, вы автоматически удаляете предыдущую фабрику L & F и UI JTextField. По умолчанию это текстовый пользовательский интерфейс Metal L & F (MetalTextFieldUI), который расширяет BasicTextUI. Это вызывает метод javax.swing.plaf.basic.BasicTextUI.uninstallUI(JComponent) и его содержимое:

public void uninstallUI(JComponent c) {
        // detach from the model
        editor.removePropertyChangeListener(updateHandler);
        editor.getDocument().removeDocumentListener(updateHandler);

        // view part
        painted = false;
        uninstallDefaults();
        rootView.setView(null);
        c.removeAll();
        LayoutManager lm = c.getLayout();
        if (lm instanceof UIResource) {
            c.setLayout(null);
        }

        // controller part
        uninstallKeyboardActions();
        uninstallListeners();

        editor = null;
    }

Обратите внимание на вызов c.removeAll() который в основном удаляет ваш ярлык из иерархии и, следовательно, вызывает проблему, которую вы видите.

1. Можно утверждать, что добавление компонентов в примитивные виджеты Swing не является идеальным, и это не то, как они должны были использоваться. Я лично считаю, что этот аргумент довольно слабый, но я знаю, что многие любители Swing его нашли.

2. Просто убедитесь, что обновили пользовательский интерфейс перед добавлением JLabel или JLabel JTextField а после обновления пользовательского интерфейса переустановите JLabel в JTextField.

Маленький пример (просто для демонстрации моего объяснения):

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.EventQueue;
import java.awt.Graphics;
import java.awt.Image;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.image.BufferedImage;

import javax.swing.ImageIcon;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;
import javax.swing.border.EmptyBorder;

public class TestAddImageToTextField {

    private static class MyJTextField extends JTextField {
        @Override
        public void updateUI() {
            removeAll();
            super.updateUI();
            Image image = buildImage();

            JLabel lblClear = new JLabel(new ImageIcon(image));
            lblClear.addMouseListener(new MouseAdapter() {
                @Override
                public void mouseClicked(MouseEvent e) {
                    MyJTextField.this.setText("");
                }
            });
            setLayout(new BorderLayout());
            add(lblClear, BorderLayout.EAST);
        }

        private Image buildImage() {
            Image image = new BufferedImage(10, 25, BufferedImage.TYPE_INT_RGB);
            Graphics graphics = image.getGraphics();
            graphics.setColor(Color.WHITE);
            graphics.fillRect(0, 0, 10, 25);
            graphics.setColor(Color.LIGHT_GRAY);
            graphics.fillOval(0, 7, 10, 10);
            graphics.setColor(Color.GRAY);
            graphics.drawLine(2, 9, 8, 15);
            graphics.drawLine(2, 15, 8, 9);
            return image;
        }
    }

    public static void main(String[] args) {
        EventQueue.invokeLater(new Runnable() {
            @Override
            public void run() {
                try {
                    TestAddImageToTextField frame = new TestAddImageToTextField();
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });
    }

    private JComponent contentPane;

    /**
     * Create the frame.
     * 
     * @throws UnsupportedLookAndFeelException
     * @throws IllegalAccessException
     * @throws InstantiationException
     * @throws ClassNotFoundException
     */
    public TestAddImageToTextField() throws ClassNotFoundException, InstantiationException, IllegalAccessException,
            UnsupportedLookAndFeelException {
        JFrame frame = new JFrame();
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setBounds(100, 100, 450, 300);
        contentPane = (JComponent) frame.getContentPane();
        contentPane.setBorder(new EmptyBorder(5, 5, 5, 5));
        contentPane.setLayout(new BorderLayout(0, 0));
        MyJTextField comp = new MyJTextField();

        contentPane.add(comp);
        frame.setVisible(true);
        installNimbusLAF();

    }

    private void installNimbusLAF() throws ClassNotFoundException, InstantiationException, IllegalAccessException,
            UnsupportedLookAndFeelException {
        int r = 250;
        int g = 250;
        int b = 250;
        UIManager.put("control", new Color(r, g, b));
        UIManager.setLookAndFeel("com.sun.java.swing.plaf.nimbus.NimbusLookAndFeel");
        UIManager.put("control", new Color(r, g, b));
        SwingUtilities.updateComponentTreeUI(contentPane);
    }

}