org.noos.xing.mydoggy.plaf.ui.ResourceManager Maven / Gradle / Ivy
The newest version!
package org.noos.xing.mydoggy.plaf.ui;
import org.noos.common.context.Context;
import org.noos.xing.mydoggy.Observable;
import org.noos.xing.mydoggy.plaf.ui.transparency.TransparencyManager;
import javax.swing.*;
import javax.swing.plaf.ComponentUI;
import java.awt.*;
import java.awt.image.BufferedImage;
import java.util.Locale;
import java.util.ResourceBundle;
/**
* This interface is used to customize not only icons, colors and internationalization but also
* ui components creation with relative customization and transparency manager.
*
* @author Angelo De Caro ([email protected])
* @since 1.3.1
*/
public interface ResourceManager extends Observable {
void setClassloader(ClassLoader classloader);
/**
* Returns an instance of class clazz using passed args.
*
* @param clazz the class of the instance to be returned.
* @param context a context where retrieve arguments.
* @return an instance of class clazz using passed args.
* @since 1.4.0
*/
T createInstance(Class clazz, Context context);
/**
* Create the component using the rule specified by the key param.
*
* @param key key whose associated rule is used to create the component.
* @param context a context where retrieve arguments.
* @return the component created using the rule specified by the key param.
* @since 1.3.1
*/
T createComponent(String key, Context context);
/**
* Create the component ui using the rule specified by the key param.
*
* @param key key whose associated rule is used to create the component.
* @param context a context where retrieve arguments.
* @return the component ui created using the rule specified by the key param.
* @since 1.3.1
*/
ComponentUI createComponentUI(String key, Context context);
/**
* Apply the customization using the rule specified by the key param.
*
* @param key key whose associated rule is used to customize the component.
* @param component the component to be customized.
* @param context a context where retrieve arguments.
* @return the component customized.
* @since 1.3.1
*/
T applyCustomization(String key, T component, Context context);
/**
* Returns the icon to which this manager maps the specified id. Returns
* null if the manager contains no mapping for this id.
*
* @param id id whose associated icon is to be returned.
* @return the icon to which this manager maps the specified id, or
* null if the manager contains no mapping for this id.
* @since 1.3.1
*/
Icon getIcon(String id);
/**
* Associates the specified icon with the specified id. If the manager previously
* contained a mapping for this id, the old icon is replaced by the specified icon.
*
* @param id id with which the specified icon is to be associated.
* @param icon icon to be associated with the specified id.
* @return previous icon associated with specified id, or null
* if there was no mapping for id.
* @since 1.3.1
*/
Icon putIcon(String id, Icon icon);
/**
* Returns the color to which this manager maps the specified id. Returns
* null if the manager contains no mapping for this id.
*
* @param id id whose associated color is to be returned.
* @return the color to which this manager maps the specified id, or
* null if the manager contains no mapping for this id.
* @since 1.3.1
*/
Color getColor(String id);
/**
* Associates the specified color with the specified id. If the manager previously
* contained a mapping for this id, the old color is replaced by the specified color.
*
* @param id id with which the specified color is to be associated.
* @param color color to be associated with the specified id.
* @return previous color associated with specified id, or null
* if there was no mapping for id.
* @since 1.3.1
*/
Color putColor(String id, Color color);
/**
* Returns the transparency manager for the windows used to manage transparency of toolwindows
* of FLOATING or FLOATING_FREE type.
*
* @return the transparency manager for the windows.
* @since 1.3.1
*/
TransparencyManager getTransparencyManager();
/**
* Sets the transparency manager for the windows used to manage transparency of toolwindows
* of FLOATING or FLOATING_FREE type.
*
* @param transparencyManager the transparency manager for the windows.
* @since 1.3.1
*/
void setTransparencyManager(TransparencyManager transparencyManager);
/**
* Returns the buffered image to which this manager maps the specified id. Returns
* null if the manager contains no mapping for this id.
*
* @param id id whose associated buffered image is to be returned.
* @return the buffered image to which this manager maps the specified id, or
* null if the manager contains no mapping for this id.
* @since 1.4.1
*/
BufferedImage getImage(String id);
/**
* Sets the locale of this manager used for the internationalization of the relative toolwindow manager.
*
* @param locale the locale to become this manager's locale
* @since 1.3.1
*/
void setLocale(Locale locale);
/**
* Sets the bundle used for the internationalization of special strings like the the toolwindow id.
*
* @param locale the locale for which a resource bundle is desired
* @param bundle the base name of the resource bundle, a fully qualified class name
* @param classLoader the class loader from which to load the resource bundle
* @see #getUserResourceBundle()
* @since 1.3.1
*/
void setUserBundle(Locale locale, String bundle, ClassLoader classLoader);
/**
* Sets the bundle used for the internationalization of special strings like the the toolwindow id.
*
* @param userBundle the ResourceBundle
* @since 1.3.1
*/
void setUserBundle(ResourceBundle userBundle);
/**
* Returns the resource bundle used for the internationalization of mydoggy.
*
* @return the resource bundle used for the internationalization of mydoggy.
* @since 1.3.1
*/
ResourceBundle getResourceBundle();
/**
* Returns the resource bundle used for the internationalization of special strings like the the toolwindow id.
*
* @return the resource bundle used for the internationalization of special strings like the the toolwindow id.
* @since 1.3.1
*/
ResourceBundle getUserResourceBundle();
/**
* This method is equivalent to getResourceBundle().getString(key)
*
* @param key the key for the desired string
* @return the string for the given key
* @since 1.3.1
*/
String getString(String key);
/**
* This method is equivalent to getUserResourceBundle().getString(key)
*
* @param key the key for the desired string
* @return the string for the given key
* @since 1.3.1
*/
String getUserString(String key);
/**
* Returns the map that contains all colors definition.
*
* @return the map that contains all colors definition.
* @since 1.5.0
*/
java.util.List getColors();
/**
* Returns the map that contains all icons definition.
*
* @return the map that contains all icons definition.
* @since 1.4.0
*/
java.util.List getIcons();
/**
* Searches for the property with the specified name in the property list.
* The method returns null if the property is not found.
*
* @param name the property bame.
* @return the value in this property list with the specified key value.
* @since 1.4.0
*/
String getProperty(String name);
/**
* Associates the specified value with the specified property name.
*
* @param name property name with which the specified value is to be associated.
* @param value value to be associated with the specified name.
* @since 1.4.0
*/
void putProperty(String name, String value);
/**
* Searches for the property with the specified name in the property list.
* The method returns defaultValue if the property is not found.
*
* @param name the property name.
* @param defaultValue the default value if the property is not found.
* @return the value in this property list with the specified key value.
* @since 1.4.0
*/
boolean getBoolean(String name, boolean defaultValue);
/**
* Associates a string representing the specified boolean value with the
* specified name. The associated string is the
* one that would be returned if the boolean value were passed to
* {@link Boolean#toString(boolean)}.
*
* @param name name with which the string form of value is to be associated.
* @param value value whose string form is to be associated with key.
* @throws NullPointerException if key is null.
* @see #getBoolean(String, boolean)
* @since 1.4.2
*/
void putBoolean(String name, boolean value);
/**
* Searches for the property with the specified name in the property list.
* The method returns defaultValue if the property is not found.
*
* @param name the property name.
* @param defaultValue the default value if the property is not found.
* @return the value in this property list with the specified key value.
* @since 1.4.2
*/
float getFloat(String name, float defaultValue);
/**
* Associates a string representing the specified float value with the
* specified name. The associated string is the
* one that would be returned if the float value were passed to
* {@link Float#toString(float)}.
*
* @param name name with which the string form of value is to be associated.
* @param value value whose string form is to be associated with key.
* @throws NullPointerException if key is null.
* @see #getFloat(String, float)
* @since 1.4.2
*/
void putFloat(String name, float value);
/**
* Searches for the property with the specified name in the property list.
* The method returns defaultValue if the property is not found.
*
* @param name the property name.
* @param defaultValue the default value if the property is not found.
* @return the value in this property list with the specified key value.
* @since 1.4.2
*/
int getInt(String name, int defaultValue);
/**
* Associates a string representing the specified int value with the
* specified name. The associated string is the
* one that would be returned if the int value were passed to
* {@link Integer#toString(int)}.
*
* @param name name with which the string form of value is to be associated.
* @param value value whose string form is to be associated with key.
* @throws NullPointerException if key is null.
* @see #getInt(String, int)
* @since 1.4.2
*/
void putInt(String name, int value);
/**
* Associates the specified value with the specified key.
*
* @param key key with which the specified value is to be associated.
* @param value value to be associated with the specified name.
* @since 1.4.1
*/
void putObject(Object key, Object value);
/**
* Searches for the object with the specified class in the property list.
* The method returns defaultValue if the object is not found.
*
* @param clazz the object class.
* @param defaultValue the default value if the object is not found.
* @return 1.4.1
*/
T getObject(Class clazz, T defaultValue);
}