com.alee.managers.style.StyleData Maven / Gradle / Ivy
Show all versions of weblaf-ui 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 component;
/**
* Applied skin.
*/
private Skin skin;
/**
* Whether or not skin was pinned.
* Pinned skin will not be changed when global skin is changed.
*/
private boolean pinnedSkin;
/**
* Style ID.
*/
private StyleId styleId;
/**
* Custom painters.
*/
private Map painters;
/**
* Related style children.
*/
private List> children;
/**
* Skin change listeners.
*/
private List listeners;
/**
* Constructs new empty style data object.
*
* @param component component this style data is referencing
*/
public StyleData ( final JComponent component )
{
super ();
// Saving component weak reference
this.component = new WeakReference ( component );
// Updating default values
this.skin = null;
this.pinnedSkin = false;
this.styleId = null;
this.painters = null;
this.children = null;
this.listeners = null;
// Adding style ID listener
component.addPropertyChangeListener ( StyleId.STYLE_PROPERTY, this );
component.addPropertyChangeListener ( StyleId.PARENT_STYLE_PROPERTY, this );
}
@Override
public void propertyChange ( final PropertyChangeEvent evt )
{
// Retrieving component
final JComponent component = StyleData.this.getComponentImpl ();
final Object styleId = component.getClientProperty ( StyleId.STYLE_PROPERTY );
if ( styleId != null )
{
// Applying style ID if it was set explicitly
if ( styleId instanceof StyleId )
{
// StyleId specified directly
StyleManager.setStyleId ( component, ( StyleId ) styleId );
}
else if ( styleId instanceof String )
{
// String style ID was passed
final String id = ( String ) styleId;
// Trying to retrieve parent
final Object parent = component.getClientProperty ( StyleId.PARENT_STYLE_PROPERTY );
if ( parent != null )
{
if ( parent instanceof JComponent )
{
// Parent provided directly
StyleManager.setStyleId ( component, StyleId.of ( id, ( JComponent ) parent ) );
}
else if ( parent instanceof WeakReference )
{
final Object p = ( ( WeakReference ) parent ).get ();
if ( p != null && p instanceof JComponent )
{
// Parent provided through weak reference
StyleManager.setStyleId ( component, StyleId.of ( id, ( JComponent ) p ) );
}
else
{
// Simple direct style
StyleManager.setStyleId ( component, StyleId.of ( id ) );
}
}
else
{
// Simple direct style
StyleManager.setStyleId ( component, StyleId.of ( id ) );
}
}
else
{
// Simple direct style
StyleManager.setStyleId ( component, StyleId.of ( id ) );
}
}
}
else
{
// Restoring default style ID value
StyleManager.restoreStyleId ( component );
}
}
/**
* Returns component this style data is referencing.
*
* @return component this style data is referencing
*/
public WeakReference getComponent ()
{
return component;
}
/**
* Returns component this style data is referencing.
*
* @return component this style data is referencing
*/
private JComponent getComponentImpl ()
{
final JComponent component = this.component.get ();
if ( component == null )
{
throw new StyleException ( "Component for style ID \"" + styleId.getCompleteId () + "\" has been destroyed" );
}
return component;
}
/**
* Returns currently applied skin.
*
* @return currently applied skin
*/
public Skin getSkin ()
{
return skin;
}
/**
* Returns whether or not skin was pinned.
* Pinned skin will not be changed when global skin is changed.
*
* @return true if skin was pinned, false otherwise
*/
public boolean isPinnedSkin ()
{
return pinnedSkin;
}
/**
* Sets whether or not skin was pinned.
*
* @param pinnedSkin whether or not skin was pinned
*/
public void setPinnedSkin ( final boolean pinnedSkin )
{
this.pinnedSkin = pinnedSkin;
}
/**
* Applies new component skin and returns previously applied skin.
*
* @param skin skin to apply
* @param applyToChildren whether or not should apply the same skin to style children
* @return previously applied skin
*/
public Skin applySkin ( final Skin skin, final boolean applyToChildren )
{
// Retrieving component and checking its existance
final JComponent component = getComponentImpl ();
// Checking that provided skin is actually different one
final boolean newSkin = skin != getSkin ();
// Saving reference to old skin
final Skin oldSkin;
if ( newSkin )
{
// Removing old skin
oldSkin = removeSkin ();
}
else
{
// Simply providing current skin
oldSkin = getSkin ();
}
// Applying new skin to specified component
if ( newSkin && skin != null )
{
skin.applySkin ( component );
this.skin = skin;
}
// Resetting pinned state if skin was changed
if ( newSkin )
{
setPinnedSkin ( false );
}
// Applying skin to component's style children
if ( skin != null && applyToChildren )
{
applyChildrenSkin ( skin );
}
// Informing about skin changes
if ( newSkin )
{
// Informing about skin changes
fireSkinChanged ( component, oldSkin, skin );
// Informing about skin visual update
fireSkinUpdated ( component, getStyleId () );
}
return oldSkin;
}
/**
* Applies skin to style children.
*
* @param skin skin to apply
*/
private void applyChildrenSkin ( final Skin skin )
{
if ( children != null )
{
for ( final WeakReference reference : children )
{
final JComponent child = reference.get ();
if ( child != null )
{
StyleManager.setSkin ( child, skin );
}
}
}
}
/**
* Updates current skin in the skinnable component.
*
* This method is used only to properly update skin on various changes.
* It is not recommended to use it outside of style manager behavior.
*/
public void updateSkin ()
{
// Retrieving component and checking its existance
final JComponent component = getComponentImpl ();
// Updating component skin
getSkin ().updateSkin ( component );
// Updating children skins
if ( children != null )
{
for ( final WeakReference reference : children )
{
final JComponent child = reference.get ();
if ( child != null )
{
StyleManager.updateSkin ( child );
}
}
}
// Informing about skin visual update
fireSkinUpdated ( component, getStyleId () );
}
/**
* Removes skin currently applied to the specified component.
*
* @return previously applied skin
*/
public Skin removeSkin ()
{
final Skin oldSkin = this.skin;
if ( this.skin != null )
{
// Retrieving component and checking its existance
final JComponent component = getComponentImpl ();
// Removing skin
this.skin.removeSkin ( component );
this.skin = null;
}
return oldSkin;
}
/**
* Returns currently used style ID.
*
* @return currently used style ID
*/
public StyleId getStyleId ()
{
return styleId;
}
/**
* Sets currently used style ID.
*
* @param styleId new style ID
*/
public void setStyleId ( final StyleId styleId )
{
// Retrieving component and checking its existance
final JComponent component = getComponentImpl ();
// Saving old style ID reference
final StyleId oldStyleId = this.styleId;
// Saving new style ID
this.styleId = styleId;
// Updating component skin
updateSkin ();
// Informing about style change
fireStyleChanged ( component, oldStyleId, styleId );
}
/**
* Returns custom painters.
*
* @return custom painters
*/
public Map getPainters ()
{
return painters;
}
/**
* Sets custom painters.
*
* @param painters custom painters
*/
public void setPainters ( final Map painters )
{
this.painters = painters;
}
/**
* Returns related style children.
*
* @return related style children
*/
public List> getChildren ()
{
return children;
}
/**
* Adds related style child.
*
* @param child related style child
*/
public void addChild ( final JComponent child )
{
if ( children == null )
{
children = new ArrayList> ( 1 );
}
children.add ( new WeakReference ( child ) );
}
/**
* Removes related style child.
*
* @param child related style child
*/
public void removeChild ( final JComponent child )
{
final Iterator> iterator = children.iterator ();
while ( iterator.hasNext () )
{
final WeakReference next = iterator.next ();
if ( next.get () == child )
{
iterator.remove ();
}
}
}
/**
* Adds style change listener.
*
* @param listener style change listener to add
*/
public void addStyleListener ( final StyleListener listener )
{
if ( listeners == null )
{
listeners = new ArrayList ( 1 );
}
listeners.add ( listener );
}
/**
* Removes style change listener.
*
* @param listener style change listener to remove
*/
public void removeStyleListener ( final StyleListener listener )
{
if ( listeners != null )
{
listeners.remove ( listener );
}
}
/**
* Informs about component skin change.
*
* @param component component which style has changed
* @param oldSkin previously used skin
* @param newSkin currently used skin
*/
private void fireSkinChanged ( final JComponent component, final Skin oldSkin, final Skin newSkin )
{
if ( listeners != null )
{
for ( final StyleListener listener : listeners )
{
listener.skinChanged ( component, oldSkin, newSkin );
}
}
}
/**
* Informs about component style change.
*
* @param component component which style has changed
* @param oldStyleId previously used style ID
* @param newStyleId currently used style ID
*/
private void fireStyleChanged ( final JComponent component, final StyleId oldStyleId, final StyleId newStyleId )
{
if ( listeners != null )
{
for ( final StyleListener listener : listeners )
{
listener.styleChanged ( component, oldStyleId, newStyleId );
}
}
}
/**
* Informs about component skin visual update.
* Skin update might occur when component style ID changes or its parent style component style ID changes.
*
* @param component component which style have been updated
* @param styleId component style ID
*/
private void fireSkinUpdated ( final JComponent component, final StyleId styleId )
{
if ( listeners != null )
{
for ( final StyleListener listener : listeners )
{
listener.skinUpdated ( component, styleId );
}
}
}
}