com.alee.managers.settings.ComponentSettingsManager Maven / Gradle / Ivy
Show all versions of weblaf-core Show documentation
/*
* This file is part of WebLookAndFeel library.
*
* WebLookAndFeel library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* WebLookAndFeel library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with WebLookAndFeel library. If not, see
* This manager should never be called directly (except the case when you register new SettingsProcessor or if you know what you are doing)
* to avoid any unexpected component behavior.
*
* @author Mikle Garin
* @see How to use SettingsManager
* @see com.alee.managers.settings.SettingsManager
* @see com.alee.managers.settings.SettingsManager
*/
public class ComponentSettingsManager
{
/**
* todo 1. JListSettingsProcessor
* todo 2. JTableSettingsProcessor
* todo 3. JScrollPaneSettingsProcessor
*/
/**
* Keys used to store custom data in JComponent.
*/
public static final String COMPONENT_SETTINGS_PROCESSOR_KEY = "settings.processor";
/**
* Registered settings processor classes.
*/
protected static final Map settingsProcessorClasses = new LinkedHashMap ();
/**
* Registered component settings processors.
*/
protected static final Map> settingsProcessors =
new WeakHashMap> ();
/**
* Whether throw exceptions on inappropriate actions or not.
*/
protected static boolean throwExceptions = true;
/**
* Whether ComponentSettingsManager is initialized or not.
*/
protected static boolean initialized = false;
/**
* Initializes ComponentSettingsManager.
*/
public static void initializeManager ()
{
if ( !initialized )
{
initialized = true;
// Initializing base settings processors
registerSettingsProcessor ( AbstractButton.class, AbstractButtonSettingsProcessor.class );
registerSettingsProcessor ( JComboBox.class, JComboBoxSettingsProcessor.class );
registerSettingsProcessor ( JSlider.class, JSliderSettingsProcessor.class );
registerSettingsProcessor ( JPasswordField.class, JPasswordFieldSettingsProcessor.class );
registerSettingsProcessor ( JTextComponent.class, JTextComponentSettingsProcessor.class );
registerSettingsProcessor ( JScrollBar.class, JScrollBarSettingsProcessor.class );
registerSettingsProcessor ( JTabbedPane.class, JTabbedPaneSettingsProcessor.class );
registerSettingsProcessor ( JRootPane.class, JRootPaneSettingsProcessor.class );
}
}
/**
* Returns whether exceptions are thrown on inappropriate actions or not.
*
* @return true if exceptions are thrown on inappropriate actions, false otherwise
*/
public static boolean isThrowExceptions ()
{
return throwExceptions;
}
/**
* Sets whether throw exceptions on inappropriate actions or not.
*
* @param throwExceptions whether throw exceptions on inappropriate actions or not
*/
public static void setThrowExceptions ( final boolean throwExceptions )
{
ComponentSettingsManager.throwExceptions = throwExceptions;
}
/**
* Returns whether the specified component is supported or not.
*
* @param component component
* @return true if the specified component is supported, false otherwise
*/
public static boolean isComponentSupported ( final JComponent component )
{
return isComponentSupported ( component.getClass () );
}
/**
* Returns whether the specified component is supported or not.
*
* @param componentType component type
* @return true if the specified component is supported, false otherwise
*/
public static boolean isComponentSupported ( final Class componentType )
{
// Checking if a suitable component processor exists
return findSuitableSettingsProcessor ( componentType ) != null;
}
/**
* Registers specified settings processor class for the specified component type.
*
* @param componentType component type
* @param settingsProcessor settings processor class
* @param settings processor type
*/
public static void registerSettingsProcessor ( final Class componentType,
final Class settingsProcessor )
{
// Saving settings processor under component type
settingsProcessorClasses.put ( componentType, settingsProcessor );
}
/**
* Returns settings processor class for the specified component type.
*
* @param componentType component type
* @return settings processor class for the specified component type
*/
protected static Class findSuitableSettingsProcessor ( final Class componentType )
{
// Looking through map with strict elements order for proper settings processor
for ( final Class type : settingsProcessorClasses.keySet () )
{
if ( ReflectUtils.isAssignable ( type, componentType ) )
{
return settingsProcessorClasses.get ( type );
}
}
return null;
}
/**
* Returns new SettingsProcessor instance for the specified SettingsProcessorData.
*
* @param data SettingsProcessorData
* @return new SettingsProcessor instance for the specified SettingsProcessorData
*/
protected static SettingsProcessor createSettingsProcessor ( final SettingsProcessorData data )
{
// Creating new settings processor from registered class
final Class settingsProcessorClass = findSuitableSettingsProcessor ( data.getComponent ().getClass () );
if ( settingsProcessorClass != null )
{
try
{
return ReflectUtils.createInstance ( settingsProcessorClass, data );
}
catch ( final Throwable e )
{
if ( throwExceptions )
{
// Throw cannot instantiate SettingsProcessor exception
throw new RuntimeException (
"Cannot instantiate SettingsProcessor class: " + settingsProcessorClass.getCanonicalName () + ".", e );
}
else
{
return null;
}
}
}
else
{
return null;
}
}
/**
* Registers component using the specified SettingsProcessorData.
* Any old SettingsProcessor for that component will be unregistered if operation is successful.
*
* @param data SettingsProcessorData
*/
public static void registerComponent ( final SettingsProcessorData data )
{
// Creating new component settings processor if needed
final SettingsProcessor settingsProcessor = createSettingsProcessor ( data );
if ( settingsProcessor != null )
{
// Saving current component settings processor
registerComponent ( data.getComponent (), settingsProcessor );
}
else if ( throwExceptions )
{
// Throw unsupported component exception
throw new RuntimeException ( "Component type " + data.getComponent ().getClass ().getCanonicalName () + " is not supported." );
}
}
/**
* Registers component using the specified SettingsProcessor.
* Any old SettingsProcessor for that component will be unregistered if operation is successful.
*
* @param component component to register
* @param settingsProcessor component settings processor
*/
public static void registerComponent ( final JComponent component, final SettingsProcessor settingsProcessor )
{
// Ensure that there is not registered processor for this component
unregisterComponent ( component );
// Saving new settings processor for the specified component
component.putClientProperty ( COMPONENT_SETTINGS_PROCESSOR_KEY, settingsProcessor );
settingsProcessors.put ( component, new WeakReference ( settingsProcessor ) );
}
/**
* Loads saved settings into the component if it is registered.
*
* @param component component registered for settings auto-save
*/
public static void loadSettings ( final JComponent component )
{
// Retrieving component settings processor
final WeakReference reference = settingsProcessors.get ( component );
final SettingsProcessor settingsProcessor = reference != null ? reference.get () : null;
if ( settingsProcessor != null )
{
// Reloading saved settings into component
settingsProcessor.load ();
}
else if ( throwExceptions )
{
// Throw unsupported component exception
throw new RuntimeException ( "Component " + component + " was not registered." );
}
}
/**
* Saves all registered components settings.
*/
public static void saveSettings ()
{
for ( final Map.Entry> entry : settingsProcessors.entrySet () )
{
saveSettings ( entry.getKey () );
}
}
/**
* Saves component settings.
*
* @param component component registered for settings auto-save
*/
public static void saveSettings ( final JComponent component )
{
// Retrieving component settings processor
final WeakReference reference = settingsProcessors.get ( component );
final SettingsProcessor settingsProcessor = reference != null ? reference.get () : null;
if ( settingsProcessor != null )
{
// Saving component settings
settingsProcessor.save ( false );
}
else if ( throwExceptions )
{
// Throw unsupported component exception
throw new RuntimeException ( "Component " + component + " was not registered." );
}
}
/**
* Unregisters component from settings auto-save.
*
* @param component component to unregister
*/
public static void unregisterComponent ( final JComponent component )
{
// Checking if component processor exists
final WeakReference reference = settingsProcessors.get ( component );
final SettingsProcessor settingsProcessor = reference != null ? reference.get () : null;
if ( settingsProcessor != null )
{
// Unregistering component listeners and actions
settingsProcessor.destroy ();
// Removing current component settings processor
component.putClientProperty ( COMPONENT_SETTINGS_PROCESSOR_KEY, null );
settingsProcessors.remove ( component );
}
// else if ( throwExceptions )
// {
// // Throw unsupported component exception
// throw new RuntimeException ( "Component " + component + " was not registered." );
// }
}
}