org.dishevelled.identify.IdLabel Maven / Gradle / Ivy

Go to download
/*

    dsh-identify  Lightweight components for identifiable beans.
    Copyright (c) 2003-2013 held jointly by the individual authors.

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.dishevelled.identify;

import java.awt.Image;
import java.awt.Dimension;
import java.awt.Rectangle;
import java.awt.Graphics;
import java.awt.ComponentOrientation;

import java.awt.event.MouseEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseListener;

import javax.swing.Icon;
import javax.swing.JLabel;
import javax.swing.ImageIcon;

import org.dishevelled.iconbundle.IconSize;
import org.dishevelled.iconbundle.IconState;
import org.dishevelled.iconbundle.IconBundle;
import org.dishevelled.iconbundle.IconTextDirection;

/**
 * An extension of JLabel that displays the name property value
 * and appropriate icon from an icon bundle for a given bean.
 *
 * @author  Michael Heuer
 */
public final class IdLabel
    extends JLabel
{
    /** Default icon size. */
    public static final IconSize DEFAULT_ICON_SIZE = IconSize.DEFAULT_32X32;

    /** Default icon state. */
    public static final IconState DEFAULT_ICON_STATE = IconState.NORMAL;

    /** Default icon text direction. */
    private static final IconTextDirection DEFAULT_ICON_TEXT_DIRECTION = IconTextDirection.LEFT_TO_RIGHT;

    /** Bound value property. */
    private Object value;

    /** Icon size. */
    private IconSize iconSize = DEFAULT_ICON_SIZE;

    /** Icon state. */
    private IconState iconState = DEFAULT_ICON_STATE;

    /** Icon text direction. */
    private IconTextDirection iconTextDirection = DEFAULT_ICON_TEXT_DIRECTION;

    /** ImageIcon wrapper for image from icon bundle. */
    private transient ImageIcon imageIcon;

    /** Dirty flag. */
    private transient boolean dirty = false;

    /** Mouseover mouse listener. */
    private MouseListener mouseoverListener = new MouseAdapter()
        {
            @Override
            public void mouseEntered(final MouseEvent e)
            {
                if (getIconState().equals(IconState.NORMAL))
                {
                    setIconState(IconState.MOUSEOVER);
                    repaint();
                }
            }

            @Override
            public void mouseExited(final MouseEvent e)
            {
                if (getIconState().equals(IconState.MOUSEOVER))
                {
                    setIconState(IconState.NORMAL);
                    repaint();
                }
            }
        };

    /**
     * Cache of the previous state, for use in returning to the
     * proper state following a call of setEnabled(true).
     */
    private transient IconState previousState = DEFAULT_ICON_STATE;


    /**
     * Create a new label with a null value.
     */
    public IdLabel()
    {
        super();

        addMouseListener(mouseoverListener);

        setValue(null);
        rebuild();
    }

    /**
     * Create a new label for the specified value.
     *
     * @param value value
     */
    public IdLabel(final Object value)
    {
        super();

        addMouseListener(mouseoverListener);

        setValue(value);
        rebuild();
    }

    /**
     * Create a new label for the specified value with the specified icon size.
     *
     * @param value value
     * @param iconSize icon size, must not be null
     */
    public IdLabel(final Object value, final IconSize iconSize)
    {
        super();

        addMouseListener(mouseoverListener);

        setValue(value);
        setIconSize(iconSize);
        rebuild();
    }


    /**
     * Return the value for this label.
     *
     * @return the value for this label
     */
    public Object getValue()
    {
        return value;
    }

    /**
     * Set the value for this label to value.
     *
     * This is a bound property.
     *
     * @param value value for this label
     */
    public void setValue(final Object value)
    {
        Object oldValue = this.value;
        this.value = value;
        firePropertyChange("value", oldValue, this.value);

        setDirty(true);
    }

    /**
     * Return the icon size for this label.
     *
     * @return the icon size for this label
     */
    public IconSize getIconSize()
    {
        return iconSize;
    }

    /**
     * Set the icon size for this label to iconSize.
     *
     * This is a bound property.
     *
     * @param iconSize icon size, must not be null
     */
    public void setIconSize(final IconSize iconSize)
    {
        if (iconSize == null)
        {
            throw new IllegalArgumentException("iconSize must not be null");
        }

        IconSize oldIconSize = this.iconSize;
        this.iconSize = iconSize;

        if (!oldIconSize.equals(this.iconSize))
        {
            setDirty(true);
            firePropertyChange("iconSize", oldIconSize, iconSize);
        }
    }

    /**
     * Return the icon state for this label.
     *
     * @return the icon state for this label
     */
    public IconState getIconState()
    {
        return iconState;
    }

    /**
     * Set the icon state for this label to iconState.
     *
     * This is a bound property.
     *
     * @param iconState icon state, must not be null
     */
    public void setIconState(final IconState iconState)
    {
        if (iconState == null)
        {
            throw new IllegalArgumentException("iconState must not be null");
        }

        IconState oldIconState = this.iconState;
        this.iconState = iconState;

        if (!oldIconState.equals(this.iconState))
        {
            setDirty(true);
            firePropertyChange("iconState", oldIconState, this.iconState);
        }
    }

    /**
     * Return the icon text direction for this label.
     *
     * @return the icon text direction for this label
     */
    IconTextDirection getIconTextDirection()
    {
        return iconTextDirection;
    }

    @Override
    public void setComponentOrientation(final ComponentOrientation orientation)
    {
        ComponentOrientation oldOrientation = getComponentOrientation();

        if (!oldOrientation.equals(orientation))
        {
            if (orientation != null)
            {
                iconTextDirection = orientation.isLeftToRight()
                    ? IconTextDirection.LEFT_TO_RIGHT : IconTextDirection.RIGHT_TO_LEFT;

                setDirty(true);
            }
        }

        super.setComponentOrientation(orientation);
    }

    @Override
    public void applyComponentOrientation(final ComponentOrientation orientation)
    {
        ComponentOrientation oldOrientation = getComponentOrientation();

        if (!oldOrientation.equals(orientation))
        {
            if (orientation != null)
            {
                iconTextDirection = orientation.isLeftToRight()
                    ? IconTextDirection.LEFT_TO_RIGHT : IconTextDirection.RIGHT_TO_LEFT;

                setDirty(true);
            }
        }

        super.applyComponentOrientation(orientation);
    }

    @Override
    public void setEnabled(final boolean enabled)
    {
        boolean previousEnabled = isEnabled();

        if (enabled && !previousEnabled)
        {
            setIconState(previousState);
        }
        else if (!enabled && previousEnabled)
        {
            previousState = getIconState();
            setIconState(IconState.DISABLED);
        }

        super.setEnabled(enabled);

        setDirty(true);
    }

    /**
     * Set the dirty flag to the logical OR of dirty
     * and the previous dirty state.
     *
     * @param dirty dirty flag
     */
    private void setDirty(final boolean dirty)
    {
        this.dirty = (this.dirty || dirty);
    }

    /**
     * Return true if a rebuild of the text and icon properties
     * is necessary.
     *
     * @return true if a rebuild of the text and icon properties
     *    is necessary
     */
    private boolean isDirty()
    {
        return dirty;
    }

    /**
     * Rebuild the text and icon properties of this label
     * with the name property and icon bundle image of
     * getValue(), respectively.
     */
    private void rebuild()
    {
        String name = IdentifyUtils.getNameFor(value);
        setText(name);

        IconBundle iconBundle = IdentifyUtils.getIconBundleFor(value);

        if (iconBundle == null)
        {
            super.setIcon(null);
            imageIcon = null;
        }
        else
        {
            Image image = iconBundle.getImage(this, iconTextDirection, iconState, iconSize);

            if (imageIcon == null)
            {
                imageIcon = new ImageIcon(image);
            }
            else
            {
                imageIcon.setImage(image);
            }

            super.setIcon(imageIcon);
        }

        dirty = false;
    }

    @Override
    public String getText()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getText();
    }

    @Override
    public Icon getIcon()
    {
        if (isDirty())
        {
            rebuild();
        }
        return imageIcon;
    }

    @Override
    public Icon getDisabledIcon()
    {
        if (isDirty())
        {
            rebuild();
        }
        return imageIcon;
    }

    @Override
    public Rectangle getBounds()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getBounds();
    }

    @Override
    public Rectangle getBounds(final Rectangle rv)
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getBounds(rv);
    }

    @Override
    public Dimension getMaximumSize()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getMaximumSize();
    }

    @Override
    public Dimension getMinimumSize()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getMinimumSize();
    }

    @Override
    public Dimension getPreferredSize()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getPreferredSize();
    }

    @Override
    public Dimension getSize()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getSize();
    }

    @Override
    public Rectangle getVisibleRect()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getVisibleRect();
    }

    @Override
    public int getHeight()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getHeight();
    }

    @Override
    public int getWidth()
    {
        if (isDirty())
        {
            rebuild();
        }
        return super.getWidth();
    }

    @Override
    public void paintComponent(final Graphics g)
    {
        if (isDirty())
        {
            rebuild();
        }
        super.paintComponent(g);
    }
}