/*
* Copyright (c) 2001-2006 JGoodies Karsten Lentzsch. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of JGoodies Karsten Lentzsch nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jdesktop.swingx.util.font;
import java.awt.Font;
import java.awt.Toolkit;
import java.util.Locale;
/**
* Provides static access to popular Windows fonts. The sizes of the font
* constants are specified in <em>typographic points</em>, approximately 1/72
* of an inch.
* <p>
*
* TODO: Consider changing the visibility of the package private methods to
* public. As an alternative we may provide a FontPolicy that can emulate the
* font choice on Windows XP/2000 and Windows Vista for different software
* resolutions (96dpi/120dpi) and desktop font size settings (Normal/Large/Extra
* Large).
*
* @author Karsten Lentzsch
* @version $Revision$
*
* @see FontSet
* @see FontSets
* @see FontPolicy
* @see FontPolicies
*
* @since 2.0
*/
public final class Fonts {
/**
* The name of the default dialog font on western Windows XP.
*/
public static final String TAHOMA_NAME = "Tahoma";
/**
* The name of the default dialog font on western Windows Vista.
*/
public static final String SEGOE_UI_NAME = "Segoe UI";
// Physical Fonts *********************************************************
/**
* This is the default font on western XP with 96dpi and normal fonts.
* Ascent=11, descent=3, height=14, dbuX=6, dbuY=12, 14dluY=21px.
*/
public static final Font TAHOMA_11PT = new Font(TAHOMA_NAME, Font.PLAIN, 11);
/**
* Ascent=13, descent=3, height=16, dbuX=8, dbuY=13, 14dluY=22.75px.
*/
public static final Font TAHOMA_13PT = new Font(TAHOMA_NAME, Font.PLAIN, 13);
/**
* Ascent=14, descent=3, height=17, dbuX=8, dbuY=14, 14dluY=24.5px.
*/
public static final Font TAHOMA_14PT = new Font(TAHOMA_NAME, Font.PLAIN, 14);
/**
* This is Segoe UI 9pt, the default font on western Vista with 96dpi.
* Ascent=13, descent=4, height=17, dbuX=7, dbuY=13, 13dluY=21.125px.
*/
public static final Font SEGOE_UI_12PT = new Font(SEGOE_UI_NAME,
Font.PLAIN, 12);
/**
* Ascent=14, descent=4, height=18, dbuX=8, dbuY=14, 13dluY=22.75px.
*/
public static final Font SEGOE_UI_13PT = new Font(SEGOE_UI_NAME,
Font.PLAIN, 13);
/**
* Ascent=16, descent=5, height=21, dbuX=9, dbuY=16, 13dluY=26px.
*/
public static final Font SEGOE_UI_15PT = new Font(SEGOE_UI_NAME,
Font.PLAIN, 15);
// Default Windows Fonts **************************************************
/**
* The default icon font on western Windows XP with 96dpi and the dialog
* font desktop setting "Normal".
*/
public static final Font WINDOWS_XP_96DPI_NORMAL = TAHOMA_11PT;
/**
* The default GUI font on western Windows XP with 96dpi and the dialog font
* desktop setting "Normal".
*/
public static final Font WINDOWS_XP_96DPI_DEFAULT_GUI = TAHOMA_11PT;
/**
* The default icon font on western Windows XP with 96dpi and the dialog
* font desktop setting "Large".
*/
public static final Font WINDOWS_XP_96DPI_LARGE = TAHOMA_13PT;
/**
* The default icon font on western Windows XP with 120dpi and the dialog
* font desktop setting "Normal".
*/
public static final Font WINDOWS_XP_120DPI_NORMAL = TAHOMA_14PT;
/**
* The default GUI font on western Windows XP with 120dpi and the dialog
* font desktop setting "Normal".
*/
public static final Font WINDOWS_XP_120DPI_DEFAULT_GUI = TAHOMA_13PT;
/**
* The default icon font on western Windows Vista with 96dpi and the dialog
* font desktop setting "Normal".
*/
public static final Font WINDOWS_VISTA_96DPI_NORMAL = SEGOE_UI_12PT;
/**
* The default icon font on western Windows Vista with 96dpi and the dialog
* font desktop setting "Large".
*/
public static final Font WINDOWS_VISTA_96DPI_LARGE = SEGOE_UI_15PT;
/**
* The default icon font on western Windows Vista with 101dpi and the dialog
* font desktop setting "Normal".
* <P>
*
* TODO: Check if this shall be removed or not.
*/
static final Font WINDOWS_VISTA_101DPI_NORMAL = SEGOE_UI_13PT;
/**
* The default icon font on western Windows Vista with 120dpi and the dialog
* font desktop setting "Normal".
*/
public static final Font WINDOWS_VISTA_120DPI_NORMAL = SEGOE_UI_15PT;
// Desktop Property Font Keys *********************************************
/**
* The desktop property key used to lookup the DEFAULTGUI font. This font
* scales with the software resolution only but works in western and
* non-western Windows environments.
*
* @see #getWindowsControlFont()
*/
static final String WINDOWS_DEFAULT_GUI_FONT_KEY = "win.defaultGUI.font";
/**
* The desktop property key used to lookup Windows' icon font. This font
* scales with the software resolution and the desktop font size setting
* (Normal/Large/Extra Large). However, in some non-western Windows
* environments this font cannot display the locale's glyphs.
* <p>
*
* Implementation Note: Windows uses the icon font to label icons in the
* Windows Explorer and other places. It seems to me that this works in
* non-western environments due to font chaining.
*
* @see #getWindowsControlFont()
*/
static final String WINDOWS_ICON_FONT_KEY = "win.icon.font";
// Instance Creation ******************************************************
private Fonts() {
// Override default constructor; prevents instantation.
}
// Font Lookup ************************************************************
static Font getDefaultGUIFontWesternModernWindowsNormal() {
return LookUtils.IS_LOW_RESOLUTION ? WINDOWS_XP_96DPI_DEFAULT_GUI
: WINDOWS_XP_120DPI_DEFAULT_GUI;
}
static Font getDefaultIconFontWesternModernWindowsNormal() {
return LookUtils.IS_LOW_RESOLUTION ? WINDOWS_XP_96DPI_NORMAL
: WINDOWS_XP_120DPI_NORMAL;
}
static Font getDefaultIconFontWesternWindowsVistaNormal() {
return LookUtils.IS_LOW_RESOLUTION ? WINDOWS_VISTA_96DPI_NORMAL
: WINDOWS_VISTA_120DPI_NORMAL;
}
/**
* Returns the Windows control font used by the JGoodies Looks version 1.x.
* It is intended for visual backward compatibility only. The font returned
* is the default GUI font that scales with the resolution (96dpi, 120dpi,
* etc) but not with the desktop font size settings (normal, large, extra
* large).
* <p>
*
* On Windows Vista, the font may be completely wrong.
*
* @return the Windows default GUI font that scales with the resolution, but
* not the desktop font size setting
*
* @throws UnsupportedOperationException
* on non-Windows platforms
*/
static Font getLooks1xWindowsControlFont() {
if (!LookUtils.IS_OS_WINDOWS)
throw new UnsupportedOperationException();
return getDesktopFont(WINDOWS_DEFAULT_GUI_FONT_KEY);
}
/**
* Looks up and returns the Windows control font. Returns the Windows icon
* title font unless it is inappropriate for the Windows version, Java
* renderer, or locale.
* <p>
*
* The icon title font scales with the resolution (96dpi, 101dpi, 120dpi,
* etc) and the desktop font size settings (normal, large, extra large).
* Older versions may return a poor font. Also, since Java 1.4 and Java 5
* render the Windows Vista icon font Segoe UI poorly, we return the default
* GUI font in these environments.
* <p>
*
* The last check is, if the icon font can display text in the default
* locale. Therefore we test if the locale's localized display name can be
* displayed by the icon font. For example, Tahoma can display "English",
* "Deutsch", but not the display name for "Chinese" in Chinese.
*
* @return the Windows control font
*
* @throws UnsupportedOperationException
* on non-Windows platforms
*/
public static Font getWindowsControlFont() {
if (!LookUtils.IS_OS_WINDOWS)
throw new UnsupportedOperationException();
Font defaultGUIFont = getDefaultGUIFont();
// Return the default GUI font on older Windows versions.
if (LookUtils.IS_OS_WINDOWS_95 || LookUtils.IS_OS_WINDOWS_98
|| LookUtils.IS_OS_WINDOWS_NT || LookUtils.IS_OS_WINDOWS_ME)
return defaultGUIFont;
// Java 1.4 and Java 5 raster the Segoe UI poorly,
// so we use the older Tahoma, if it can display the localized text.
if (LookUtils.IS_OS_WINDOWS_VISTA) {
if (LookUtils.IS_JAVA_1_4_OR_5) {
Font tahoma = getDefaultGUIFontWesternModernWindowsNormal();
return Boolean.TRUE.equals(canDisplayLocalizedText(tahoma,
Locale.getDefault())) ? tahoma : defaultGUIFont;
}
}
Font iconFont = getDesktopFont(WINDOWS_ICON_FONT_KEY);
return Boolean.TRUE.equals(canDisplayLocalizedText(iconFont, Locale
.getDefault())) ? iconFont : defaultGUIFont;
}
/**
* Looks up and returns the Windows defaultGUI font. Works around a bug with
* Java 1.4.2_11, 1.5.0_07, and 1.6 b89 in the Vista Beta2, where the
* win.defaultGUI.font desktop property returns null. In this case a logical
* "Dialog" font is used as fallback.
*
* @return the Windows defaultGUI font, or a dialog font as fallback.
*/
private static Font getDefaultGUIFont() {
Font font = getDesktopFont(WINDOWS_DEFAULT_GUI_FONT_KEY);
if (font != null)
return font;
return new Font("Dialog", Font.PLAIN, 12);
}
/**
* Checks and answers whether the given font can display text that is
* localized for the specified locale. Returns <code>null</code> if we
* can't test it.
* <p>
*
* First checks, if the locale's display language is available in localized
* form, for example "Deutsch" for the German locale. If so, we check if the
* given font can display the localized display language.
* <p>
*
* Otherwise we check some known combinations of fonts and locales and
* return the associated results. For all other combinations,
* <code>null</code> is returned to indicate that we don't know whether
* the font can display text in the given locale.
*
* @param font
* the font to be tested
* @param locale
* the locale to be used
* @return <code>Boolean.TRUE</code> if the font can display the locale's
* text, <code>Boolean.FALSE</code> if not, <code>null</code> if
* we don't know
*
* @since 2.0.4
*/
public static Boolean canDisplayLocalizedText(Font font, Locale locale) {
if (localeHasLocalizedDisplayLanguage(locale)) {
return Boolean.valueOf(canDisplayLocalizedDisplayLanguage(font,
locale));
}
String fontName = font.getName();
String language = locale.getLanguage();
if ("Tahoma".equals(fontName)) {
if ("hi".equals(language))
return Boolean.FALSE;
else if ("ja".equals(language))
return Boolean.FALSE;
else if ("ko".equals(language))
return Boolean.FALSE;
else if ("zh".equals(language))
return Boolean.FALSE;
}
if ("Microsoft Sans Serif".equals(fontName)) {
if ("ja".equals(language))
return Boolean.FALSE;
else if ("ko".equals(language))
return Boolean.FALSE;
else if ("zh".equals(language))
return Boolean.FALSE;
}
return null;
}
/**
* Checks and answers if the given font can display the locale's localized
* display language, for example "English" for English, "Deutsch" for
* German, etc. The test invokes <code>Font#canDisplayUpTo</code> on the
* localized display language. In a Chinese locale this test will check if
* the font can display Chinese glyphs.
*
* @param font
* the font to be tested
* @param locale
* the locale to be used
* @return true if the font can display the locale's localized display
* language, false otherwise
*/
private static boolean canDisplayLocalizedDisplayLanguage(Font font,
Locale locale) {
String testString = locale.getDisplayLanguage(locale);
int index = font.canDisplayUpTo(testString);
return index == -1;
}
/**
* Checks and answers whether the locale's display language is available in
* a localized form, for example "Deutsch" for the German locale.
*
* @param locale
* the Locale to test
* @return true if the display language is localized, false if not
*/
private static boolean localeHasLocalizedDisplayLanguage(Locale locale) {
if (locale.getLanguage().equals(Locale.ENGLISH.getLanguage()))
return true;
String englishDisplayLanguage = locale
.getDisplayLanguage(Locale.ENGLISH);
String localizedDisplayLanguage = locale.getDisplayLanguage(locale);
return !(englishDisplayLanguage.equals(localizedDisplayLanguage));
}
/**
* Looks up and returns a font using the default toolkit's desktop
* properties.
*
* @param fontName
* the name of the font to return
* @return the font
*/
private static Font getDesktopFont(String fontName) {
Toolkit toolkit = Toolkit.getDefaultToolkit();
return (Font) toolkit.getDesktopProperty(fontName);
}
}