PlafUtilities (Tentackle Swing 2.1.1 API)

java.lang.Object
- org.tentackle.swing.plaf.PlafUtilities

@Service(value=PlafUtilities.class)
public class PlafUtilities
extends Object

Pluggable Look And Feel common helper methods.

Author:: harald

Field Summary

Fields
Modifier and Type Field and Description

static String TENTACKLE_ICONREALM
The namespace of the icons for tentackle (can be used by apps)

Fields
Modifier and Type	Field and Description
`static String`	`TENTACKLE_ICONREALM` The namespace of the icons for tentackle (can be used by apps)

Constructor Summary

Constructors
Constructor and Description

PlafUtilities()
Creates the utility instance.

Constructors
Constructor and Description
`PlafUtilities()` Creates the utility instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IconProvider`	`addIconProvider(IconProvider iconProvider)` Registers an IconProvider.
`Color`	`brighter(Color color, double factor)` Make a color brighter.
`Color`	`darker(Color color, double factor)` Make a color darker.
`Color`	`getAlarmBackgroundColor()`
`Color`	`getAlarmColor()`
`Color`	`getDropFieldActiveColor()`
`Color`	`getDropFieldInactiveColor()`
`ImageIcon`	`getIcon(String name)` Gets the icon for the tentackle default realm.
`ImageIcon`	`getIcon(String realm, String name)` Gets an icon for the current look-and-feel, a given realm and icon name.
`UIManager.LookAndFeelInfo[]`	`getInstalledTentackleLookAndFeels()` Gets all installed `TentackleLookAndFeel`s.
`static PlafUtilities`	`getInstance()` The singleton.
`Color`	`getListSelectedBackgroundColor()`
`Color`	`getListSelectedDisabledForegroundColor()`
`Color`	`getListSelectedForegroundColor()`
`Color`	`getListUnselectedDisabledForegroundColor()`
`Color`	`getListUnselectedForegroundColor()`
`Color`	`getTableBackgroundColor()`
`Color`	`getTableEditCellBorderColor()`
`Color`	`getTableFocusCellBackgroundColor()`
`Color`	`getTableFocusCellForegroundColor()`
`Color`	`getTableForegroundColor()`
`Color`	`getTableSelectionBackgroundColor()`
`Color`	`getTableSelectionForegroundColor()`
`Color`	`getTextFieldBackgroundColor()`
`Color`	`getTextFieldInactiveBackgroundColor()`
`Object`	`getUIManagerDefault(String... keys)` Gets a UIManager default.
`void`	`installLookAndFeel(String clazzName)` Installs a LAF by its classname.
`void`	`installTentackleLookAndFeels()` Installs all Tentackle Look and Feels
`boolean`	`isFocusAnimated()` Retrievs the current setting for the focus animation.
`IconProvider`	`removeIconProvider(String realm)` Unregisters an IconProvider for a given realm.
`void`	`setAlarmBackgroundColor(Color aAlarmBackgroundColor)`
`void`	`setAlarmColor(Color aAlarmColor)`
`void`	`setDropFieldActiveColor(Color aDropFieldActiveColor)`
`void`	`setDropFieldInactiveColor(Color aDropFieldInactiveColor)`
`void`	`setFocusAnimated(boolean flag)` Configures the animated keyboard focus for non-text components that can grab the keyboard focus, such as comboboxes, radio buttons or check boxes.
`void`	`setListSelectedBackgroundColor(Color aListSelectedBackgroundColor)`
`void`	`setListSelectedDisabledForegroundColor(Color aListSelectedDisabledForegroundColor)`
`void`	`setListSelectedForegroundColor(Color aListSelectedForegroundColor)`
`void`	`setListUnselectedDisabledForegroundColor(Color aListUnselectedDisabledForegroundColor)`
`void`	`setListUnselectedForegroundColor(Color aListUnselectedForegroundColor)`
`void`	`setTableBackgroundColor(Color aTableBackgroundColor)`
`void`	`setTableEditCellBorderColor(Color aTableEditCellBorderColor)`
`void`	`setTableFocusCellBackgroundColor(Color aTableFocusCellBackgroundColor)`
`void`	`setTableFocusCellForegroundColor(Color aTableFocusCellForegroundColor)`
`void`	`setTableForegroundColor(Color aTableForegroundColor)`
`void`	`setTableSelectionBackgroundColor(Color aTableSelectionBackgroundColor)`
`void`	`setTableSelectionForegroundColor(Color aTableSelectionForegroundColor)`
`void`	`setTextFieldBackgroundColor(Color aTextFieldBackgroundColor)`
`void`	`setTextFieldInactiveBackgroundColor(Color aTextFieldInactiveBackgroundColor)`
`void`	`triggerLookAndFeelUpdated()` Invoke this method whenever the plaf has changed.

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

- Field Detail
  - TENTACKLE_ICONREALM
```
public static final String TENTACKLE_ICONREALM
```
    The namespace of the icons for tentackle (can be used by apps)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PlafUtilities
```
public PlafUtilities()
```
    Creates the utility instance.
- Method Detail
  - getInstance
```
public static PlafUtilities getInstance()
```
    The singleton.
    
    Returns:
    
    the singleton
  - installLookAndFeel
```
public void installLookAndFeel(String clazzName)
```
    Installs a LAF by its classname.
    If the LAF is not loadable, no exception will be thrown. This method is used to load known lafs. If a LAF is in the classpath and provides a method get<name>Name(), then UIManager.installLookAndFeel(java.lang.String, java.lang.String) is invoked.
    Otherwise it is silently ignored.
    The LAF may be any kind of LAF. However, due to the checked presence of the method, in fact only TentackleLookAndFeels will be loaded.
    
    Parameters:
    
    clazzName - the classname of the LAF
  - installTentackleLookAndFeels
```
public void installTentackleLookAndFeels()
```
    Installs all Tentackle Look and Feels
  - getInstalledTentackleLookAndFeels
```
public UIManager.LookAndFeelInfo[] getInstalledTentackleLookAndFeels()
```
    Gets all installed TentackleLookAndFeels.
    The method invokes UIManager.getInstalledLookAndFeels() and returns a list of all LAFs that implement TentackleLookAndFeel.
    
    Returns:
    
    the installed tentackle plafs, never null
  - setFocusAnimated
```
public void setFocusAnimated(boolean flag)
```
    Configures the animated keyboard focus for non-text components that can grab the keyboard focus, such as comboboxes, radio buttons or check boxes. By default, the animation is enabled. For non-tentackle plafs this setting has no effect.
    
    Parameters:
    
    flag - the boolean value which is true to enable the animation, false to turn it off
  - isFocusAnimated
```
public boolean isFocusAnimated()
```
    Retrievs the current setting for the focus animation.
    
    Returns:
    
    true if focus is animated
  - getAlarmColor
```
public Color getAlarmColor()
```
    Returns:
    
    the alarmColor
  - setAlarmColor
```
public void setAlarmColor(Color aAlarmColor)
```
    Parameters:
    
    aAlarmColor - the alarmColor to set
  - getAlarmBackgroundColor
```
public Color getAlarmBackgroundColor()
```
    Returns:
    
    the alarmBackgroundColor
  - setAlarmBackgroundColor
```
public void setAlarmBackgroundColor(Color aAlarmBackgroundColor)
```
    Parameters:
    
    aAlarmBackgroundColor - the alarmBackgroundColor to set
  - getListSelectedForegroundColor
```
public Color getListSelectedForegroundColor()
```
    Returns:
    
    the listSelectedForegroundColor
  - setListSelectedForegroundColor
```
public void setListSelectedForegroundColor(Color aListSelectedForegroundColor)
```
    Parameters:
    
    aListSelectedForegroundColor - the listSelectedBackgroundColor to set
  - getListSelectedBackgroundColor
```
public Color getListSelectedBackgroundColor()
```
    Returns:
    
    the listSelectedBackgroundColor
  - setListSelectedBackgroundColor
```
public void setListSelectedBackgroundColor(Color aListSelectedBackgroundColor)
```
    Parameters:
    
    aListSelectedBackgroundColor - the listSelectedBackgroundColor to set
  - getListUnselectedForegroundColor
```
public Color getListUnselectedForegroundColor()
```
    Returns:
    
    the listUnselectedForegroundColor
  - setListUnselectedForegroundColor
```
public void setListUnselectedForegroundColor(Color aListUnselectedForegroundColor)
```
    Parameters:
    
    aListUnselectedForegroundColor - the listUnselectedForegroundColor to set
  - getListSelectedDisabledForegroundColor
```
public Color getListSelectedDisabledForegroundColor()
```
    Returns:
    
    the listSelectedDisabledForegroundColor
  - setListSelectedDisabledForegroundColor
```
public void setListSelectedDisabledForegroundColor(Color aListSelectedDisabledForegroundColor)
```
    Parameters:
    
    aListSelectedDisabledForegroundColor - the listSelectedDisabledForegroundColor to set
  - getListUnselectedDisabledForegroundColor
```
public Color getListUnselectedDisabledForegroundColor()
```
    Returns:
    
    the listUnselectedDisabledForegroundColor
  - setListUnselectedDisabledForegroundColor
```
public void setListUnselectedDisabledForegroundColor(Color aListUnselectedDisabledForegroundColor)
```
    Parameters:
    
    aListUnselectedDisabledForegroundColor - the listUnselectedDisabledForegroundColor to set
  - getTableForegroundColor
```
public Color getTableForegroundColor()
```
    Returns:
    
    the tableForegroundColor
  - setTableForegroundColor
```
public void setTableForegroundColor(Color aTableForegroundColor)
```
    Parameters:
    
    aTableForegroundColor - the tableForegroundColor to set
  - getTableBackgroundColor
```
public Color getTableBackgroundColor()
```
    Returns:
    
    the tableBackgroundColor
  - setTableBackgroundColor
```
public void setTableBackgroundColor(Color aTableBackgroundColor)
```
    Parameters:
    
    aTableBackgroundColor - the tableBackgroundColor to set
  - getTableFocusCellForegroundColor
```
public Color getTableFocusCellForegroundColor()
```
    Returns:
    
    the tableFocusCellForegroundColor
  - setTableFocusCellForegroundColor
```
public void setTableFocusCellForegroundColor(Color aTableFocusCellForegroundColor)
```
    Parameters:
    
    aTableFocusCellForegroundColor - the tableFocusCellForegroundColor to set
  - getTableFocusCellBackgroundColor
```
public Color getTableFocusCellBackgroundColor()
```
    Returns:
    
    the tableFocusCellBackgroundColor
  - setTableFocusCellBackgroundColor
```
public void setTableFocusCellBackgroundColor(Color aTableFocusCellBackgroundColor)
```
    Parameters:
    
    aTableFocusCellBackgroundColor - the tableFocusCellBackgroundColor to set
  - getTableSelectionForegroundColor
```
public Color getTableSelectionForegroundColor()
```
    Returns:
    
    the tableSelectionForegroundColor
  - setTableSelectionForegroundColor
```
public void setTableSelectionForegroundColor(Color aTableSelectionForegroundColor)
```
    Parameters:
    
    aTableSelectionForegroundColor - the tableSelectionForegroundColor to set
  - getTableSelectionBackgroundColor
```
public Color getTableSelectionBackgroundColor()
```
    Returns:
    
    the tableSelectionBackgroundColor
  - setTableSelectionBackgroundColor
```
public void setTableSelectionBackgroundColor(Color aTableSelectionBackgroundColor)
```
    Parameters:
    
    aTableSelectionBackgroundColor - the tableSelectionBackgroundColor to set
  - getDropFieldActiveColor
```
public Color getDropFieldActiveColor()
```
    Returns:
    
    the dropFieldActiveColor
  - setDropFieldActiveColor
```
public void setDropFieldActiveColor(Color aDropFieldActiveColor)
```
    Parameters:
    
    aDropFieldActiveColor - the dropFieldActiveColor to set
  - getDropFieldInactiveColor
```
public Color getDropFieldInactiveColor()
```
    Returns:
    
    the dropFieldInactiveColor
  - setDropFieldInactiveColor
```
public void setDropFieldInactiveColor(Color aDropFieldInactiveColor)
```
    Parameters:
    
    aDropFieldInactiveColor - the dropFieldInactiveColor to set
  - getTableEditCellBorderColor
```
public Color getTableEditCellBorderColor()
```
    Returns:
    
    the tableEditCellBorderColor
  - setTableEditCellBorderColor
```
public void setTableEditCellBorderColor(Color aTableEditCellBorderColor)
```
    Parameters:
    
    aTableEditCellBorderColor - the tableEditCellBorderColor to set
  - getTextFieldBackgroundColor
```
public Color getTextFieldBackgroundColor()
```
    Returns:
    
    the textFieldBackgroundColor
  - setTextFieldBackgroundColor
```
public void setTextFieldBackgroundColor(Color aTextFieldBackgroundColor)
```
    Parameters:
    
    aTextFieldBackgroundColor - the textFieldBackgroundColor to set
  - getTextFieldInactiveBackgroundColor
```
public Color getTextFieldInactiveBackgroundColor()
```
    Returns:
    
    the textFieldInactiveBackgroundColor
  - setTextFieldInactiveBackgroundColor
```
public void setTextFieldInactiveBackgroundColor(Color aTextFieldInactiveBackgroundColor)
```
    Parameters:
    
    aTextFieldInactiveBackgroundColor - the textFieldInactiveBackgroundColor to set
  - addIconProvider
```
public IconProvider addIconProvider(IconProvider iconProvider)
```
    Registers an IconProvider. Applications can register their own providers for the their namespaces.
    
    Parameters:
    
    iconProvider - the provider to register
    
    Returns:
    
    null if there was no provider for the provider's realm, the old provider otherwise
  - removeIconProvider
```
public IconProvider removeIconProvider(String realm)
```
    Unregisters an IconProvider for a given realm.
    
    Parameters:
    
    realm - the realm to remove the provider for
    
    Returns:
    
    null if there was no provider for the provider's realm, the old provider otherwise
  - getIcon
```
public ImageIcon getIcon(String realm,
                         String name)
                  throws MissingResourceException
```
    Gets an icon for the current look-and-feel, a given realm and icon name.
    
    Parameters:
    
    realm - the icon's namespace
    
    name - the name if the icon
    
    Returns:
    
    the icon
    
    Throws:
    
    MissingResourceException - if no such icon
  - getIcon
```
public ImageIcon getIcon(String name)
                  throws MissingResourceException
```
    Gets the icon for the tentackle default realm.
    
    Parameters:
    
    name - the name if the icon
    
    Returns:
    
    the icon
    
    Throws:
    
    MissingResourceException - if no such icon
  - getUIManagerDefault
```
public Object getUIManagerDefault(String... keys)
```
    Gets a UIManager default.
    
    Parameters:
    
    keys - the list of keys to try
    
    Returns:
    
    the resource
  - triggerLookAndFeelUpdated
```
public void triggerLookAndFeelUpdated()
```
    Invoke this method whenever the plaf has changed.
  - brighter
```
public Color brighter(Color color,
                      double factor)
```
    Make a color brighter.
    
    Parameters:
    
    color - the original color
    
    factor - the factor (Color uses 0.7)
    
    Returns:
    
    the brighter color
    
    See Also:
    
    Color.brighter()
  - darker
```
public Color darker(Color color,
                    double factor)
```
    Make a color darker.
    
    Parameters:
    
    color - the original color
    
    factor - the factor (Color uses 0.7)
    
    Returns:
    
    the darker color
    
    See Also:
    
    Color.darker()

Class PlafUtilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TENTACKLE_ICONREALM

Constructor Detail

PlafUtilities

Method Detail

getInstance

installLookAndFeel

installTentackleLookAndFeels

getInstalledTentackleLookAndFeels

setFocusAnimated

isFocusAnimated

getAlarmColor

setAlarmColor

getAlarmBackgroundColor

setAlarmBackgroundColor

getListSelectedForegroundColor

setListSelectedForegroundColor

getListSelectedBackgroundColor

setListSelectedBackgroundColor

getListUnselectedForegroundColor

setListUnselectedForegroundColor

getListSelectedDisabledForegroundColor

setListSelectedDisabledForegroundColor

getListUnselectedDisabledForegroundColor

setListUnselectedDisabledForegroundColor

getTableForegroundColor

setTableForegroundColor

getTableBackgroundColor

setTableBackgroundColor

getTableFocusCellForegroundColor

setTableFocusCellForegroundColor

getTableFocusCellBackgroundColor

setTableFocusCellBackgroundColor

getTableSelectionForegroundColor

setTableSelectionForegroundColor

getTableSelectionBackgroundColor

setTableSelectionBackgroundColor

getDropFieldActiveColor

setDropFieldActiveColor

getDropFieldInactiveColor

setDropFieldInactiveColor

getTableEditCellBorderColor

setTableEditCellBorderColor

getTextFieldBackgroundColor

setTextFieldBackgroundColor

getTextFieldInactiveBackgroundColor

setTextFieldInactiveBackgroundColor

addIconProvider

removeIconProvider

getIcon

getIcon

getUIManagerDefault

triggerLookAndFeelUpdated

brighter

darker