Использование HTML отлично работает для меня. Проблема в том, что шрифт по умолчанию уже выделен жирным шрифтом, поэтому вы не видите другого.
Попробуйте использовать тег "курсив" или тег "шрифт" и укажите другой цвет, чтобы увидеть разницу.
Или вместо передачи текстовой строки вы можете передать свой собственный JLabel с пользовательским шрифтом. Что-то вроде:
String message = "<html>The File <b> file </b> already exists</html>";
JLabel label = new JLabel(message);
label.setFont( UIManager.getFont("TextField.font") );
int result = JOptionPane.showConfirmDialog(
this,
label,
"File already exists!",
JOptionPane.YES_NO_OPTION);