com.alee.managers.style.data.SkinInfoConverter Maven / Gradle / Ivy
The newest version!
/*
* 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 > resourceMap = new LinkedHashMap> ();
/**
* Constructs SkinInfoConverter with the specified mapper and reflection provider.
*
* @param mapper mapper
* @param reflectionProvider reflection provider
*/
public SkinInfoConverter ( final Mapper mapper, final ReflectionProvider reflectionProvider )
{
super ( mapper, reflectionProvider );
}
/**
* Adds custom resource that will be used to change the default resources load strategy.
* If specified skin XML files will be taken from this map instead of being read from the actual file.
* This was generally added to support quick styles replacement by the {@link com.alee.extended.style.StyleEditor} application.
*
* @param nearClass class near which real XML is located
* @param src real XML location
* @param xml XML to use instead the real one
*/
public static void addCustomResource ( final String nearClass, final String src, final String xml )
{
Map nearClassMap = resourceMap.get ( nearClass );
if ( nearClassMap == null )
{
nearClassMap = new LinkedHashMap ();
resourceMap.put ( nearClass, nearClassMap );
}
nearClassMap.put ( src, xml );
}
@Override
public boolean canConvert ( final Class type )
{
return type.equals ( SkinInfo.class );
}
@Override
public Object unmarshal ( final HierarchicalStreamReader reader, final UnmarshallingContext context )
{
// Skin class provided for include skin or extension skin
final String superSkinClass = ( String ) context.get ( SKIN_CLASS );
// Have to perform read in try-catch to properly cleanup skin class
// Cleanup will only be performed if the skin was read by this specific method call
try
{
final SkinInfo skinInfo = new SkinInfo ();
// Updating skin class with initial value
// It might get replaced before we get to actual usage of this value
// That depends on whether or not skin class node is provided
skinInfo.setSkinClass ( superSkinClass );
// Checking unmarshalling mode
final Object mdo = context.get ( META_DATA_ONLY_KEY );
final boolean metaDataOnly = mdo != null && ( Boolean ) mdo;
// Creating component style
List iconSets = new ArrayList ( 1 );
final List styles = new ArrayList ( 10 );
while ( reader.hasMoreChildren () )
{
// Read next node
reader.moveDown ();
final String nodeName = reader.getNodeName ();
if ( nodeName.equals ( ID_NODE ) )
{
// Reading skin unique ID
skinInfo.setId ( reader.getValue () );
}
else if ( nodeName.equals ( CLASS_NODE ) )
{
// Reading skin class canonical name
final String skinClass = reader.getValue ();
// Saving skin class into skin information
skinInfo.setSkinClass ( skinClass );
// Adding skin into context, even if this is a subsequent skin
// Since it should be defined in the beginning of XML this value will be passed to underlying converters
// This way we can provide it into {@link com.alee.managers.style.data.ComponentStyleConverter}
context.put ( SKIN_CLASS, skinClass );
}
else if ( nodeName.equals ( ICON_NODE ) )
{
// Reading skin icon
// It is always located near skin class
final Class skinClass = ReflectUtils.getClassSafely ( skinInfo.getSkinClass () );
skinInfo.setIcon ( new ImageIcon ( skinClass.getResource ( reader.getValue () ) ) );
}
else if ( nodeName.equals ( TITLE_NODE ) )
{
// Reading skin title
skinInfo.setTitle ( reader.getValue () );
}
else if ( nodeName.equals ( DESCRIPTION_NODE ) )
{
// Reading skin description
skinInfo.setDescription ( reader.getValue () );
}
else if ( nodeName.equals ( AUTHOR_NODE ) )
{
// Reading skin author
skinInfo.setAuthor ( reader.getValue () );
}
else if ( nodeName.equals ( SUPPORTED_SYSTEMS_NODE ) )
{
// Reading OS systems supported by this skin
skinInfo.setSupportedSystems ( reader.getValue () );
}
else if ( nodeName.equals ( EXTENDS_NODE ) )
{
// Reading skins supported by the extension
List extendedSkins = skinInfo.getExtendedSkins ();
if ( extendedSkins == null )
{
extendedSkins = new ArrayList ( 1 );
skinInfo.setExtendedSkins ( extendedSkins );
}
extendedSkins.add ( reader.getValue () );
}
else if ( nodeName.equals ( ICON_SET_NODE ) && !metaDataOnly )
{
// Reading included icon set
final String className = reader.getValue ();
final Class realClass = mapper.realClass ( className );
final IconSet iconSet = readIconSet ( realClass );
// Merging icon sets to avoid duplicates
iconSets = Merge.basicRaw ().merge ( iconSets, CollectionUtils.asList ( iconSet ) );
}
else if ( nodeName.equals ( STYLE_NODE ) && !metaDataOnly )
{
// Reading separate style
final ComponentStyle style = ( ComponentStyle ) context.convertAnother ( styles, ComponentStyle.class );
// Simply adding additional style to the end
styles.add ( style );
}
else if ( nodeName.equals ( INCLUDE_NODE ) && !metaDataOnly )
{
// Reading included skin
final String nearClass = reader.getAttribute ( NEAR_CLASS_ATTRIBUTE );
final String realClass = nearClass != null ? mapper.realClass ( nearClass ).getCanonicalName () : null;
final String file = reader.getValue ();
final Resource resource = new Resource ( realClass, file );
final SkinInfo include = readInclude ( skinInfo, resource );
// Merging icon sets to avoid duplicates
iconSets = Merge.basicRaw ().merge ( iconSets, include.getIconSets () );
// Simply adding additional styles to the end
styles.addAll ( include.getStyles () );
}
reader.moveUp ();
}
// Saving all read icon sets
skinInfo.setIconSets ( iconSets );
// Saving all read styles into the skin
// At this point there might be more than one style with the same ID
skinInfo.setStyles ( styles );
// Returning complete skin information
return skinInfo;
}
finally
{
// Restoring previous skin class value
// This will also reset the skin class back to {@code null} if this is main skin
context.put ( SKIN_CLASS, superSkinClass );
}
}
/**
* Returns included skin information.
*
* @param skinInfo skin information
* @param resource included resourse file
* @return included skin information
*/
protected SkinInfo readInclude ( final SkinInfo skinInfo, final Resource resource )
{
// Replacing null relative class with skin class
if ( resource.getClassName () == null )
{
final String skinClass = skinInfo.getSkinClass ();
if ( skinClass == null )
{
final String msg = "Included skin file '%s' specified but its '%s' is not set";
throw new StyleException ( String.format ( msg, resource.getPath (), CLASS_NODE ) );
}
resource.setClassName ( skinClass );
}
// Reading skin part from included file
return loadSkinInfo ( skinInfo, resource );
}
/**
* Returns icon set created using specified icon set class.
*
* @param className icon set class
* @return icon set created using specified icon set class
*/
protected IconSet readIconSet ( final Class className )
{
try
{
return ReflectUtils.createInstance ( className );
}
catch ( final Exception e )
{
final String msg = "Unable to load icon set '%s'";
throw new StyleException ( String.format ( msg, className ), e );
}
}
/**
* Loads SkinInfo from the specified resource file.
* It will use an XML from a predefined resources map if it exists there.
*
* @param skinInfo skin information
* @param resource XML resource file
* @return loaded SkinInfo
*/
protected SkinInfo loadSkinInfo ( final SkinInfo skinInfo, final Resource resource )
{
try
{
final XStreamContext context = new XStreamContext ( SKIN_CLASS, skinInfo.getSkinClass () );
final Map nearClassMap = resourceMap.get ( resource.getClassName () );
if ( nearClassMap != null )
{
final String xml = nearClassMap.get ( resource.getPath () );
if ( xml != null )
{
return XmlUtils.fromXML ( xml, context );
}
else
{
return XmlUtils.fromXML ( resource, context );
}
}
else
{
return XmlUtils.fromXML ( resource, context );
}
}
catch ( final Exception e )
{
final String msg = "Included skin file '%s' cannot be read";
throw new StyleException ( String.format ( msg, resource.getPath () ), e );
}
}
}