com.alee.managers.style.StyleableComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
Show all versions of weblaf-ui Show documentation
WebLaf is a Java Swing Look and Feel and extended components library for cross-platform applications
/*
* 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 componentIcons =
new EnumMap ( StyleableComponent.class );
/**
* Lazily initialized component types map by their UI class IDs.
*/
private static final Map componentByUIClassID =
new HashMap ( values ().length );
/**
* Lazily initialized component types map by their UI classes.
*/
private static final Map, StyleableComponent> componentByUIClass =
new HashMap, StyleableComponent> ( values ().length );
/**
* Styleable component class.
* It is provided directly in this enum.
*/
protected final Class componentClass;
/**
* Styleable component UI class ID.
* It is provided directly in this enum.
*/
protected final String uiClassID;
/**
* Styleable component default UI class canonical name.
* It is taken from {@link com.alee.laf.WebLookAndFeel} class constants.
*/
protected final String defaultUIClass;
/**
* Styleable component default style ID.
* It is taken from {@link com.alee.managers.style.StyleId} class constants.
*/
protected final StyleId defaultStyleId;
/**
* Constructs a reference to component with specified settings.
*
* @param componentClass component class for this component type
* @param uiClassID UI class ID used by LookAndFeel to store various settings
* @param defaultUIClass default UI class canonical name
* @param styleId default style ID
*/
private StyleableComponent ( final Class componentClass, final String uiClassID, final String defaultUIClass,
final StyleId styleId )
{
this.componentClass = componentClass;
this.uiClassID = uiClassID;
this.defaultUIClass = defaultUIClass;
this.defaultStyleId = styleId;
}
/**
* Returns component class for this component type.
*
* @return component class for this component type
*/
public Class getComponentClass ()
{
return componentClass;
}
/**
* Returns UI class ID used by LookAndFeel to store various settings.
*
* @return UI class ID
*/
public String getUIClassID ()
{
return uiClassID;
}
/**
* Returns default UI class canonical name.
* This value is used in WebLookAndFeel to provide default UI classes.
* However they can be reassigned before WebLookAndFeel installation.
*
* @return default UI class canonical name
*/
public String getDefaultUIClass ()
{
return defaultUIClass;
}
/**
* Returns UI class for this component type.
* Result of this method is not cached because UI classes might be changed in runtime.
*
* @return UI class for this component type
*/
public Class getUIClass ()
{
final Class type = ReflectUtils.getClassSafely ( UIManager.getString ( getUIClassID () ) );
final Class defaultType = ReflectUtils.getClassSafely ( getDefaultUIClass () );
return ReflectUtils.isAssignable ( defaultType, type ) ? type : defaultType;
}
/**
* Returns default style ID for this component type.
*
* @return default style ID for this component type
*/
public StyleId getDefaultStyleId ()
{
return defaultStyleId;
}
/**
* Returns component type icon.
*
* @return component type icon
*/
@Override
public ImageIcon getIcon ()
{
if ( componentIcons.containsKey ( this ) )
{
return componentIcons.get ( this );
}
else
{
try
{
final ImageIcon icon = new ImageIcon ( StyleableComponent.class.getResource ( "icons/styleable/" + this + ".png" ) );
componentIcons.put ( this, icon );
return icon;
}
catch ( final Throwable e )
{
Log.get ().error ( "Unable to find component icon: " + this, e );
componentIcons.put ( this, null );
return null;
}
}
}
/**
* Returns component title.
*
* @return component title
*/
@Override
public String getTitle ()
{
return ReflectUtils.getClassName ( getComponentClass () );
}
/**
* Returns whether or not specified component is supported.
*
* @param component component to determine type for
* @return true if specified component is supported, false otherwise
*/
public static boolean isSupported ( final Component component )
{
return component instanceof JComponent && isSupported ( ( ( JComponent ) component ).getUIClassID () );
}
/**
* Returns whether or not component with the specified UI class ID is supported.
*
* @param uiClassID component UI class ID
* @return true if component with the specified UI class ID is supported, false otherwise
*/
public static boolean isSupported ( final String uiClassID )
{
return getImpl ( uiClassID ) != null;
}
/**
* Returns whether or not component with the specified UI is supported.
*
* @param ui component UI
* @return true if component with the specified UI is supported, false otherwise
*/
public static boolean isSupported ( final ComponentUI ui )
{
return isSupported ( ui.getClass () );
}
/**
* Returns whether or not component with the specified UI class is supported.
*
* @param uiClass UI class
* @return true if component with the specified UI class is supported, false otherwise
*/
public static boolean isSupported ( final Class uiClass )
{
return getImpl ( uiClass ) != null;
}
/**
* Returns supported component type by component.
*
* @param component component to determine type for
* @return supported component type by component
* @throws com.alee.managers.style.StyleException in case component is not supported
*/
public static StyleableComponent get ( final JComponent component )
{
return get ( component.getUIClassID () );
}
/**
* Returns supported component type by UI class ID.
*
* @param uiClassID component UI class ID
* @return supported component type by UI class ID
* @throws com.alee.managers.style.StyleException in case component is not supported
*/
public static StyleableComponent get ( final String uiClassID )
{
final StyleableComponent type = getImpl ( uiClassID );
if ( type == null )
{
throw new StyleException ( "Unsupported component UI class ID: " + uiClassID );
}
return type;
}
/**
* Returns supported component type by component UI.
*
* @param ui component UI
* @return supported component type by component UI
*/
public static StyleableComponent get ( final ComponentUI ui )
{
return get ( ui.getClass () );
}
/**
* Returns supported component type by component UI class.
*
* @param uiClass UI class
* @return supported component type by component UI class
* @throws com.alee.managers.style.StyleException in case component is not supported
*/
public static StyleableComponent get ( final Class uiClass )
{
final StyleableComponent type = getImpl ( uiClass );
if ( type == null )
{
throw new StyleException ( "Unsupported component UI class: " + uiClass );
}
return type;
}
/**
* Returns supported component type by UI class ID.
*
* @param uiClassID UI class ID
* @return supported component type by UI class ID
*/
private static StyleableComponent getImpl ( final String uiClassID )
{
if ( componentByUIClassID.size () == 0 )
{
for ( final StyleableComponent supportedComponent : values () )
{
componentByUIClassID.put ( supportedComponent.getUIClassID (), supportedComponent );
}
}
return componentByUIClassID.get ( uiClassID );
}
/**
* Returns supported component type by component UI class.
*
* @param uiClass UI class
* @return supported component type by component UI class
*/
private static StyleableComponent getImpl ( final Class uiClass )
{
StyleableComponent type = componentByUIClass.get ( uiClass );
if ( type == null )
{
// This method uses a different cache due to possibility of overriden UI classes usage
// Generally it caches types returned by provided UI classes instead of default ones
for ( final StyleableComponent supportedComponent : values () )
{
final Class typeClass = supportedComponent.getUIClass ();
if ( ReflectUtils.isAssignable ( typeClass, uiClass ) )
{
type = supportedComponent;
componentByUIClass.put ( uiClass, supportedComponent );
break;
}
}
}
return type;
}
/**
* Returns list of component types which supports painters.
*
* @return list of component types which supports painters
*/
public static List list ()
{
return CollectionUtils.asList ( values () );
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy