Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.jgoodies.looks
Class Options

    java.lang.Object
      com.jgoodies.looks.Options

    public final class Options

extends Object

Provides access to optional features of the JGoodies L&Fs via a key to the system properties, via a key for the `UIDefaults` table via a method or all of them.

API users can use this class' constants or their values to configure the JGoodies L&amP;f. Using the constants requires the Looks library classes in the class path of the using application/applet. Where using the String values doesn't require having this class in the class path.

TODO: Uncomment the constant for the combo renderer is-border-removable client property key in the Looks version 2.1.

Version:
  $Revision: 1.10 $
Author:
  Karsten Lentzsch

Field Summary
`static String` | `COMBO_POPUP_PROTOTYPE_DISPLAY_VALUE_KEY` A JComboBox client property key for the combo's popup menu prototype display value.
`static String` | `DEFAULT_ICON_SIZE_KEY`
`static String` | `DEFAULT_LOOK_NAME` The class name of the default JGoodies L&f, PlasticXP.
`static String` | `EMBEDDED_TABS_KEY` A JTabbedPane client property key that indicates that tabs are painted with a special embedded appearance.
`static String` | `HEADER_STYLE_KEY` A client property key for JMenuBar and JToolBar style hints.
`static String` | `IS_ETCHED_KEY` A JScrollPane client property key for a hint that the scroll pane border should be etched.
`static String` | `IS_NARROW_KEY` Deprecated. As of the Looks 2.0 the narrow button property is enabled or disabled only globally via `USE_NARROW_BUTTONS_KEY` or `setUseNarrowButtons(boolean)`.
`static String` | `JGOODIES_WINDOWS_NAME` The class name of the JGoodies Windows L&f.
`static String` | `NO_CONTENT_BORDER_KEY` A JTabbedPane client property key that indicates that no content border shall be painted.
`static String` | `NO_ICONS_KEY` A JMenu client property key for a hint that the menu items in the menu have no icons.
`static String` | `NO_MARGIN_KEY` A JPopupMenu client property key for a hint that the border shall have no extra margin.
`static String` | `PLASTIC_CONTROL_FONT_KEY` A key for setting the default control font in Plastic L&fs.
`static String` | `PLASTIC_FONT_POLICY_KEY` A key for setting a custom FontPolicy for the Plastic L&fs.
`static String` | `PLASTIC_MENU_FONT_KEY` A key for setting the default menu font in Plastic L&fs.
`static String` | `PLASTIC_NAME` The class name of the JGoodies Plastic L&f.
`static String` | `PLASTIC3D_NAME` The class name of the JGoodies Plastic3D L&f.
`static String` | `PLASTICXP_NAME` The class name of the JGoodies PlasticXP L&f.
`static String` | `POPUP_DROP_SHADOW_ENABLED_KEY`
`static String` | `TAB_ICONS_ENABLED_KEY`
`static String` | `TEXT_AREA_INFO_BACKGROUND_KEY` Deprecated. We suggest to use a factory that vends JTextArea's with the background set to the editable background instead.
`static String` | `TREE_LINE_STYLE_ANGLED_VALUE` A JTree client property value that indicates that lines shall be drawn.
`static String` | `TREE_LINE_STYLE_KEY` A JTree client property key for a tree line style hint.
`static String` | `TREE_LINE_STYLE_NONE_VALUE` A JTree client property value that indicates that lines shall be hidden.
`static String` | `USE_NARROW_BUTTONS_KEY`
`static String` | `USE_SYSTEM_FONTS_APP_KEY` A convenience constant for the standard Swing UIDefaults key that configures the use of system fonts.
`static String` | `USE_SYSTEM_FONTS_KEY` A convenience constant for the standard Swing system property key that configures the use of system fonts.
`static String` | `WINDOWS_CONTROL_FONT_KEY` A key for setting the default control font in the Windows L&f.
`static String` | `WINDOWS_FONT_POLICY_KEY` A key for setting a custom FontPolicy for the Windows L&fs.
`static String` | `WINDOWS_MENU_FONT_KEY` A key for setting the default menu font in the Windows L&f.

Method Summary
`static String` | `getCrossPlatformLookAndFeelClassName()` Returns the class name for a cross-platform `LookAndFeel`.
`static Dimension` | `getDefaultIconSize()` Returns the default icon size that is used in menus, menu items and toolbars.
`static String` | `getReplacementClassNameFor(String className)` Returns the class name that can be used to replace the specified `LookAndFeel` class name.
`static String` | `getSystemLookAndFeelClassName()` Returns the class name for a system specific `LookAndFeel`.
`static boolean` | `getUseNarrowButtons()` Checks and answers if we shall use narrow button margins of 4 pixels.
`static boolean` | `getUseSystemFonts()` Returns whether native system fonts shall be used, `true` by default unless disabled in the system properties or UIManager.
`static boolean` | `isPopupDropShadowActive()` Checks and answers whether popup drop shadows are active.
`static boolean` | `isPopupDropShadowEnabled()` Checks and answers whether the optional drop shadows for PopupMenus are enabled or disabled.
`static boolean` | `isTabIconsEnabled()` Checks and answers if we shall use icons in JTabbedPanes.
`static void` | `putLookAndFeelReplacement(String original, String replacement)` Puts a replacement name for a given `LookAndFeel` class name in the list of all look and feel replacements.
`static void` | `removeLookAndFeelReplacement(String original)` Removes a replacement name for a given `LookAndFeel` class name from the list of all look and feel replacements.
`static void` | `setDefaultIconSize(Dimension defaultIconSize)` Sets the default icon size.
`static void` | `setPopupDropShadowEnabled(boolean b)` Enables or disables drop shadows in PopupMenus.
`static void` | `setTabIconsEnabled(boolean b)` Enables or disables the use of icons in JTabbedPanes.
`static void` | `setUseNarrowButtons(boolean b)` Globally sets the use narrow or standard button margins.
`static void` | `setUseSystemFonts(boolean useSystemFonts)` Sets a value in the UIManager to indicate, that a look&feel may use the native system fonts.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### PLASTIC_NAME

    public static final String PLASTIC_NAME

  The class name of the JGoodies Plastic L&f.

  See Also:
    Constant Field Values

### PLASTIC3D_NAME

    public static final String PLASTIC3D_NAME

  The class name of the JGoodies Plastic3D L&f.

  See Also:
    Constant Field Values

### PLASTICXP_NAME

    public static final String PLASTICXP_NAME

  The class name of the JGoodies PlasticXP L&f.

  See Also:
    Constant Field Values

### JGOODIES_WINDOWS_NAME

    public static final String JGOODIES_WINDOWS_NAME

  The class name of the JGoodies Windows L&f.

  See Also:
    Constant Field Values

### DEFAULT_LOOK_NAME

    public static final String DEFAULT_LOOK_NAME

  The class name of the default JGoodies L&f, PlasticXP.

  See Also:
    Constant Field Values

### PLASTIC_FONT_POLICY_KEY

    public static final String PLASTIC_FONT_POLICY_KEY

  A key for setting a custom FontPolicy for the Plastic L&fs. Used for both the system properties and the UIDefaults table.

  See Also:
    `PlasticLookAndFeel.getFontPolicy()`, `PlasticLookAndFeel.setFontPolicy(FontPolicy)`, Constant Field Values

### PLASTIC_CONTROL_FONT_KEY

    public static final String PLASTIC_CONTROL_FONT_KEY

  A key for setting the default control font in Plastic L&fs. Used for both the system properties and the UIDefaults table.

  See Also:
    `FontPolicies.customSettingsPolicy(FontPolicy)`, Constant Field Values

### PLASTIC_MENU_FONT_KEY

    public static final String PLASTIC_MENU_FONT_KEY

  A key for setting the default menu font in Plastic L&fs. Used for both the system properties and the UIDefaults table.

  See Also:
    `FontPolicies.customSettingsPolicy(FontPolicy)`, Constant Field Values

### WINDOWS_FONT_POLICY_KEY

    public static final String WINDOWS_FONT_POLICY_KEY

  A key for setting a custom FontPolicy for the Windows L&fs. Used for both the system properties and the UIDefaults table.

  See Also:
    `WindowsLookAndFeel.getFontPolicy()`, `WindowsLookAndFeel.setFontPolicy(FontPolicy)`, Constant Field Values

### WINDOWS_CONTROL_FONT_KEY

    public static final String WINDOWS_CONTROL_FONT_KEY

  A key for setting the default control font in the Windows L&f. Used for both the system properties and the UIDefaults table.

  See Also:
    `FontPolicies.customSettingsPolicy(FontPolicy)`, Constant Field Values

### WINDOWS_MENU_FONT_KEY

    public static final String WINDOWS_MENU_FONT_KEY

  A key for setting the default menu font in the Windows L&f. Used for both the system properties and the UIDefaults table.

  See Also:
    `FontPolicies.customSettingsPolicy(FontPolicy)`, Constant Field Values

### USE_SYSTEM_FONTS_KEY

    public static final String USE_SYSTEM_FONTS_KEY

  A convenience constant for the standard Swing system property key that configures the use of system fonts.

  See Also:
    `getUseSystemFonts()`, `setUseSystemFonts(boolean)`, Constant Field Values

### USE_SYSTEM_FONTS_APP_KEY

    public static final String USE_SYSTEM_FONTS_APP_KEY

  A convenience constant for the standard Swing UIDefaults key that configures the use of system fonts.

  See Also:
    `getUseSystemFonts()`, `setUseSystemFonts(boolean)`, Constant Field Values

### DEFAULT_ICON_SIZE_KEY

    public static final String DEFAULT_ICON_SIZE_KEY

See Also:
  Constant Field Values

### USE_NARROW_BUTTONS_KEY

    public static final String USE_NARROW_BUTTONS_KEY

See Also:
  Constant Field Values

### TAB_ICONS_ENABLED_KEY

    public static final String TAB_ICONS_ENABLED_KEY

See Also:
  Constant Field Values

### POPUP_DROP_SHADOW_ENABLED_KEY

    public static final String POPUP_DROP_SHADOW_ENABLED_KEY

See Also:
  Constant Field Values

### IS_NARROW_KEY

    public static final String IS_NARROW_KEY

  Deprecated. As of the Looks 2.0 the narrow button property is enabled or disabled only globally via `USE_NARROW_BUTTONS_KEY` or `setUseNarrowButtons(boolean)`.
  A JButton client property key for a hint that the button margin should be narrow.

  See Also:
    Constant Field Values

### IS_ETCHED_KEY

    public static final String IS_ETCHED_KEY

  A JScrollPane client property key for a hint that the scroll pane border should be etched.

  See Also:
    Constant Field Values

### HEADER_STYLE_KEY

    public static final String HEADER_STYLE_KEY

  A client property key for JMenuBar and JToolBar style hints. Available styles are: `HeaderStyle.Single` and `HeaderStyle.Both`.

  See Also:
    `HeaderStyle`, `BorderStyle`, Constant Field Values

### NO_ICONS_KEY

    public static final String NO_ICONS_KEY

  A JMenu client property key for a hint that the menu items in the menu have no icons.

  See Also:
    Constant Field Values

### NO_MARGIN_KEY

    public static final String NO_MARGIN_KEY

  A JPopupMenu client property key for a hint that the border shall have no extra margin. This is useful if the popup menu contains only a single component, for example a scrollpane.

  See Also:
    Constant Field Values

### TEXT_AREA_INFO_BACKGROUND_KEY

    public static final String TEXT_AREA_INFO_BACKGROUND_KEY

  Deprecated. We suggest to use a factory that vends JTextArea's with the background set to the editable background instead.
  A JTextArea client property key for a hint that the text area shall use the editable background, even if it's not editable. This is useful if you display info text with text areas.

  Since:
    2.0
  See Also:
    Constant Field Values

### TREE_LINE_STYLE_KEY

    public static final String TREE_LINE_STYLE_KEY

  A JTree client property key for a tree line style hint.

  See Also:
    `TREE_LINE_STYLE_ANGLED_VALUE`, `TREE_LINE_STYLE_NONE_VALUE`, Constant Field Values

### TREE_LINE_STYLE_ANGLED_VALUE

    public static final String TREE_LINE_STYLE_ANGLED_VALUE

  A JTree client property value that indicates that lines shall be drawn.

  See Also:
    `TREE_LINE_STYLE_KEY`, Constant Field Values

### TREE_LINE_STYLE_NONE_VALUE

    public static final String TREE_LINE_STYLE_NONE_VALUE

  A JTree client property value that indicates that lines shall be hidden.

  See Also:
    `TREE_LINE_STYLE_KEY`, Constant Field Values

### NO_CONTENT_BORDER_KEY

    public static final String NO_CONTENT_BORDER_KEY

  A JTabbedPane client property key that indicates that no content border shall be painted. Supported by the JGoodies Windows L&f and the JGoodies Plastic look&feel family. This effect will be achieved also if the EMBEDDED property is true.

  See Also:
    Constant Field Values

### EMBEDDED_TABS_KEY

    public static final String EMBEDDED_TABS_KEY

  A JTabbedPane client property key that indicates that tabs are painted with a special embedded appearance. Supported by the JGoodies Windows L&f and the JGoodies Plastic look&feel family. As a side effect of the embedded appearance, supporting L&fs won't paint the content border.

  See Also:
    Constant Field Values

### COMBO_POPUP_PROTOTYPE_DISPLAY_VALUE_KEY

    public static final String COMBO_POPUP_PROTOTYPE_DISPLAY_VALUE_KEY

  A JComboBox client property key for the combo's popup menu prototype display value. If this key is set, the value will be used to compute the combo popup width. This optional feature is supported by the JGoodies Windows L&f as well as the JGoodies Plastic L&fs.

  See Also:
    Constant Field Values

Method Detail

### getUseSystemFonts

    public static boolean getUseSystemFonts()

  Returns whether native system fonts shall be used, `true` by default unless disabled in the system properties or UIManager.

  Returns:
    true unless disabled in the system properties or UIManager
  See Also:
    `setUseSystemFonts(boolean)`, `USE_SYSTEM_FONTS_KEY`, `USE_SYSTEM_FONTS_APP_KEY`

### setUseSystemFonts

    public static void setUseSystemFonts(boolean useSystemFonts)

  Sets a value in the UIManager to indicate, that a look&feel may use the native system fonts.

  Parameters:
    `useSystemFonts` - true to enable system fonts in the UIManager
  See Also:
    `getUseSystemFonts()`, `USE_SYSTEM_FONTS_KEY`, `USE_SYSTEM_FONTS_APP_KEY`

### getDefaultIconSize

    public static Dimension getDefaultIconSize()

  Returns the default icon size that is used in menus, menu items and toolbars. Menu items that have no icon set are aligned using the default icon dimensions.

  Returns:
    the dimension of the default icon
  See Also:
    `setDefaultIconSize(Dimension)`

### setDefaultIconSize

    public static void setDefaultIconSize(Dimension defaultIconSize)

  Sets the default icon size.

  Parameters:
    `defaultIconSize` - the default icon size to set
  See Also:
    `getDefaultIconSize()`

### getUseNarrowButtons

    public static boolean getUseNarrowButtons()

  Checks and answers if we shall use narrow button margins of 4 pixels. As of the Looks version 1.4 the default value is `true` (narrow) for the JGoodies Windows L&F and the JGoodies Plastic L&F family. The native Windows L&F uses narrow margins too. The default can be disabled in the system properties or UIManager.

  Note: Using narrow button margins can potentially cause compatibility issues, if you don't take care that command buttons with short labels (OK) get a reasonable minimum width. Therefore you can get back to wide button margins using `#setUseNarrowButtons`. Sun's L&F implementations use a wider button margin of 14 pixels.

  Narrow button margins make it easier to give buttons in a button bar the same width, even if some button labels are long. And narrow margins are useful for embedded command buttons that just have an icon, or an ellipsis (...). Many style guides recommend to use a minimum button width in command button bars, for example 50 dialog units on Windows. Such a minimum width makes it easier to click a button, just because the button area has a reasonable minimum size. To ensure a reasonable button minimum width, you may configure a LayoutManager, use a special panel for command button bars, or a factory that vends command button bars.

  The JGoodies FormLayout can layout button bars that comply with both the MS Windows Layout Guidelines and the Mac Aqua Human Interface Guidelines. The JGoodies Forms contains a ButtonBarBuilder to build command button bars, and a ButtonBarFactory that vends frequently used button bars.

  Returns:
    `true` (default) if all buttons shall use narrow margins, `false` for wider margins
  See Also:
    `setUseNarrowButtons(boolean)`, `USE_NARROW_BUTTONS_KEY`

### setUseNarrowButtons

    public static void setUseNarrowButtons(boolean b)

  Globally sets the use narrow or standard button margins.

  In previous versions of the JGoodies Looks this setting was supported also for individual buttons - primarily to offer visual backward compatibility with Sun L&Fs.

  Parameters:
    `b` - true to use narrow button margins globally
  See Also:
    `getUseNarrowButtons()`, `USE_NARROW_BUTTONS_KEY`

### isTabIconsEnabled

    public static boolean isTabIconsEnabled()

  Checks and answers if we shall use icons in JTabbedPanes. By default, tab icons are enabled. If the user has set a system property, we log a message about the choosen style.

  Returns:
    true if icons in tabbed panes are enabled, false if disabled
  See Also:
    `setTabIconsEnabled(boolean)`

### setTabIconsEnabled

    public static void setTabIconsEnabled(boolean b)

  Enables or disables the use of icons in JTabbedPanes.

  Parameters:
    `b` - true to enable icons in tabbed panes, false to disable them
  See Also:
    `isTabIconsEnabled()`

### isPopupDropShadowActive

    public static boolean isPopupDropShadowActive()

  Checks and answers whether popup drop shadows are active. This feature shall be inactive with toolkits that use native drop shadows, such as Aqua on the Mac OS X. It is also inactive if the ShadowPopup cannot snapshot the desktop background (due to security and AWT exceptions). Otherwise the feature's enablement state is returned.

  Currently only the Mac OS X is detected as platform where the toolkit uses native drop shadows.

  Returns:
    true if drop shadows are active, false if inactive
  See Also:
    `isPopupDropShadowEnabled()`, `setPopupDropShadowEnabled(boolean)`

### isPopupDropShadowEnabled

    public static boolean isPopupDropShadowEnabled()

  Checks and answers whether the optional drop shadows for PopupMenus are enabled or disabled.

  Returns:
    true if drop shadows are enabled, false if disabled
  See Also:
    `isPopupDropShadowActive()`, `setPopupDropShadowEnabled(boolean)`, `POPUP_DROP_SHADOW_ENABLED_KEY`

### setPopupDropShadowEnabled

    public static void setPopupDropShadowEnabled(boolean b)

  Enables or disables drop shadows in PopupMenus. Note that drop shadows are always inactive on platforms that provide native drop shadows such as the Mac OS X.

  It is recommended to enable this feature only on platforms that accelerate translucency and snapshots with the hardware.

  Parameters:
    `b` - true to enable drop shadows, false to disable them
  See Also:
    `isPopupDropShadowActive()`, `isPopupDropShadowEnabled()`

### putLookAndFeelReplacement

    public static void putLookAndFeelReplacement(String original,
                                                 String replacement)

  Puts a replacement name for a given `LookAndFeel` class name in the list of all look and feel replacements.

  Parameters:
    `original` - the name of the look-and-feel to replace
    `replacement` - the name of the replacement look-and-feel
  See Also:
    `removeLookAndFeelReplacement(String)`, `getReplacementClassNameFor(String)`

### removeLookAndFeelReplacement

    public static void removeLookAndFeelReplacement(String original)

  Removes a replacement name for a given `LookAndFeel` class name from the list of all look and feel replacements.

  Parameters:
    `original` - the name of the look-and-feel that has been replaced
  See Also:
    `putLookAndFeelReplacement(String, String)`, `getReplacementClassNameFor(String)`

### getReplacementClassNameFor

    public static String getReplacementClassNameFor(String className)

  Returns the class name that can be used to replace the specified `LookAndFeel` class name.

  Parameters:
    `className` - the name of the look-and-feel class
  Returns:
    the name of the suggested replacement class
  See Also:
    `putLookAndFeelReplacement(String, String)`, `removeLookAndFeelReplacement(String)`

### getCrossPlatformLookAndFeelClassName

    public static String getCrossPlatformLookAndFeelClassName()

  Returns the class name for a cross-platform `LookAndFeel`.

  Returns:
    the name of a cross platform look-and-feel class
  See Also:
    `getSystemLookAndFeelClassName()`

### getSystemLookAndFeelClassName

    public static String getSystemLookAndFeelClassName()

  Returns the class name for a system specific `LookAndFeel`.

  Returns:
    the name of the system look-and-feel class
  See Also:
    `getCrossPlatformLookAndFeelClassName()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2006 JGoodies Karsten Lentzsch. All Rights Reserved.