com.jgoodies.looks
public final class Options extends Object
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.
Version: $Revision: 1.21 $
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 | COMBO_RENDERER_IS_BORDER_REMOVABLE
A client property key for combo box renderer components.
|
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 | HI_RES_DISABLED_ICON_CLIENT_KEY
A client property key for components with a disabled icon
such as buttons, labels, and tabbed panes. |
static String | HI_RES_GRAY_FILTER_ENABLED_KEY
A UIDefaults key for enabling/disabling the new high-resolution
gray filter globally. |
static String | INVERT_SELECTION_CLIENT_KEY
A JTextField client property key that specifies the direction
how text shall be selected on focus gain - if at all:
from start to end vs. end to start.
|
static String | IS_ETCHED_KEY
A JScrollPane client property key for a hint
that the scroll pane border should be etched. |
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 | NO_REPLACEMENT
A replacement used to replace a given L&f with nothing,
that indicates that it should not be used. |
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 | 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_MICRO_LAYOUT_POLICY_KEY
A UIManager key for setting a custom MicroLayoutPolicy
for the Plastic L&fs.
|
static String | PLASTIC_NAME
The class name of the JGoodies Plastic L&f. |
static String | POPUP_DROP_SHADOW_ENABLED_KEY
A UIDefaults key for the popup drop shadow enablement.
|
static String | SELECT_ON_FOCUS_GAIN_CLIENT_KEY
A JTextField client property key that specifies whether all text shall
be selected on focus gain. |
static String | SELECT_ON_FOCUS_GAIN_KEY
A UIDefaults key for the global default whether text fields
shall select all text on focus gain. |
static String | SET_CARET_TO_START_ON_FOCUS_LOST_CLIENT_KEY
A JTextField client property key that specifies whether the caret
shall be positioned at the start on focus lost.
|
static String | TAB_ICONS_ENABLED_KEY |
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.
|
static String | WINDOWS_MICRO_LAYOUT_POLICY_KEY
A UIManager key for setting a custom MicroLayoutPolicy
for 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 Boolean | getSelectOnFocusGainEnabled(JTextComponent c)
Returns component's individual setting for the select on focus gain
feature.
|
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 | isHiResGrayFilterEnabled()
Checks and answers whether the new high-resolution gray filter
is enabled or disabled. |
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 | isSelectOnFocusGainActive(JTextComponent c)
Checks and answers whether the select all on focus gain feature
is active for the given field. |
static boolean | isSelectOnFocusGainEnabled()
Checks and answers whether the global default for text fields
is to select all text on focus gain. |
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 | setHiResGrayFilterEnabled(boolean b)
Enables or disables the new high-resolution gray filter globally.
|
static void | setPopupDropShadowEnabled(boolean b)
Enables or disables drop shadows in PopupMenus.
|
static void | setSelectOnFocusGainEnabled(boolean b)
Enables or disables the select on focus gain feature globally.
|
static void | setSelectOnFocusGainEnabled(JTextField field, Boolean b)
Overrides the global default for the select all feature for the given
text field.
|
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. 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. |
static void | setUseSystemFonts(boolean useSystemFonts)
Sets a value in the UIManager to indicate,
that a look&feel may use the native system fonts.
|
Since: 2.1
See Also: WindowsComboBoxUI#paintCurrentValue(java.awt.Graphics, java.awt.Rectangle, boolean)
HeaderStyle.Single
and
HeaderStyle.Both
.
See Also: HeaderStyle BorderStyle
Since: 2.1
See Also: isHiResGrayFilterEnabled Options HI_RES_GRAY_FILTER_ENABLED_KEY
Since: 2.1
See Also: Options HI_RES_DISABLED_ICON_CLIENT_KEY
You can set the client property using:
aTextField.putClientProperty("JGoodies.invertSelection", Boolean.TRUE);
Since: 2.2
Since: 2.1.3
See Also: customSettingsPolicy
See Also: getFontPolicy setFontPolicy
See Also: customSettingsPolicy
See Also: getMicroLayoutPolicy setMicroLayoutPolicy
See Also: isPopupDropShadowEnabled Options
This feature can be set using Options. If you want to avoid to link application code to the JGoodies Looks library, you can set the client property directly using:
aTextField.putClientProperty("JGoodies.selectAllOnFocusGain", Boolean.TRUE);
Since: 2.2
Since: 2.2
You can set the client property using:
aTextField.putClientProperty("JGoodies.setCaretToStartOnFocusLost", Boolean.TRUE);
Since: 2.2
See Also: TREE_LINE_STYLE_KEY
See Also: TREE_LINE_STYLE_ANGLED_VALUE TREE_LINE_STYLE_NONE_VALUE
See Also: TREE_LINE_STYLE_KEY
See Also: getUseSystemFonts Options
See Also: getUseSystemFonts Options
See Also: customSettingsPolicy
See Also: WindowsLookAndFeel#getFontPolicy() WindowsLookAndFeel#setFontPolicy(FontPolicy)
See Also: customSettingsPolicy
See Also: WindowsLookAndFeel#getMicroLayoutPolicy() WindowsLookAndFeel#setMicroLayoutPolicy(MicroLayout)
LookAndFeel
.
Returns: the name of a cross platform look-and-feel class
See Also: getSystemLookAndFeelClassName
Returns: the dimension of the default icon
See Also: setDefaultIconSize
LookAndFeel
class name.
Parameters: className the name of the look-and-feel class
Returns: the name of the suggested replacement class
See Also: Options removeLookAndFeelReplacement
Parameters: c the component to check
Returns: Boolean.TRUE if enabled, Boolean.FALSE if disabled, null if the global default is used
Since: 2.2
LookAndFeel
.
Returns: the name of the system look-and-feel class
See Also: getCrossPlatformLookAndFeelClassName
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: Options USE_NARROW_BUTTONS_KEY
true
by default unless disabled in the system properties or UIManager.
Returns: true unless disabled in the system properties or UIManager
See Also: Options USE_SYSTEM_FONTS_KEY USE_SYSTEM_FONTS_APP_KEY
Returns: true if the high-resolution gray filter is enabled, false if disabled
Since: 2.1
See Also: Options HI_RES_GRAY_FILTER_ENABLED_KEY HI_RES_DISABLED_ICON_CLIENT_KEY
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 Options
Returns: true if drop shadows are enabled, false if disabled
See Also: isPopupDropShadowActive Options POPUP_DROP_SHADOW_ENABLED_KEY
Parameters: c the component to check
Returns: true if the feature is enabled for c
or globally,
false if the feature is disabled for c
or globally
disabled.
Since: 2.2
For all full description and background see Options.
Returns: true if the select all feature is enabled globally, false if disabled
Since: 2.2
See Also: SELECT_ON_FOCUS_GAIN_KEY SELECT_ON_FOCUS_GAIN_CLIENT_KEY
Returns: true if icons in tabbed panes are enabled, false if disabled
See Also: Options
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 getReplacementClassNameFor
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: Options getReplacementClassNameFor
Parameters: defaultIconSize the default icon size to set
See Also: getDefaultIconSize
HI_RES_DISABLED_ICON_CLIENT_KEY
.
Parameters: b true to enable the high-resolution gray filter, false to disable them
Since: 2.1
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
SELECT_ALL_ON_FOCUS_GAIN_CLIENT_KEY
.
It is enabled by default.Background: If users are more likely going to reenter the entire value in a text field, all text shall be selected on focus gain. If users are more likely to edit a text, the caret shall be placed at the end of the text.
Parameters: b true to enable the select all on focus gain, false to disable this feature globally
Since: 2.2
Parameters: field the field to set this feature b Boolean.TRUE to enable, Boolean.FALSE to disable, null to use the global default
Since: 2.2
Parameters: b true to enable icons in tabbed panes, false to disable them
See Also: isTabIconsEnabled
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
Parameters: useSystemFonts true to enable system fonts in the UIManager
See Also: getUseSystemFonts USE_SYSTEM_FONTS_KEY USE_SYSTEM_FONTS_APP_KEY