org.wings.tree.SDefaultTreeCellRenderer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS 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 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.tree;

import org.wings.SComponent;
import org.wings.SConstants;
import org.wings.SIcon;
import org.wings.SLabel;
import org.wings.STree;
import org.wings.resource.ResourceManager;

/**
 * @author Holger Engels
 * @author Armin Haaf
 */
public class SDefaultTreeCellRenderer
        extends SLabel
        implements STreeCellRenderer
{
    private StringBuilder nameBuffer = new StringBuilder();

    // Icons
    /**
     * Icon used to show non-leaf nodes that aren't expanded.
     */
    transient protected SIcon closedIcon;

    /**
     * Icon used to show leaf nodes.
     */
    transient protected SIcon leafIcon;

    /**
     * Icon used to show non-leaf nodes that are expanded.
     */
    transient protected SIcon openIcon;

    /**
     * Create a SDefaultTreeCellRenderer with default properties.
     */
    public SDefaultTreeCellRenderer() {
        setHorizontalAlignment(SConstants.LEFT);
        setLeafIcon(getDefaultLeafIcon());
        setClosedIcon(getDefaultClosedIcon());
        setOpenIcon(getDefaultOpenIcon());
    }

    /**
     * Returns the default icon, for the current laf, that is used to
     * represent non-leaf nodes that are expanded.
     */
    public static SIcon getDefaultOpenIcon() {
        return (SIcon) ResourceManager.getObject("TreeCG.openIcon", SIcon.class);
    }

    /**
     * Returns the default icon, for the current laf, that is used to
     * represent non-leaf nodes that are not expanded.
     */
    public static SIcon getDefaultClosedIcon() {
        return (SIcon) ResourceManager.getObject("TreeCG.closedIcon", SIcon.class);
    }

    /**
     * Returns the default icon, for the current laf, that is used to
     * represent leaf nodes.
     */
    public static SIcon getDefaultLeafIcon() {
        return (SIcon) ResourceManager.getObject("TreeCG.leafIcon", SIcon.class);
    }

    /**
     * Sets the icon used to represent non-leaf nodes that are expanded.
     */
    public void setOpenIcon(SIcon newIcon) {
        SIcon oldVal = this.openIcon;
        openIcon = newIcon;
        propertyChangeSupport.firePropertyChange("openIcon", oldVal, this.openIcon);
    }

    /**
     * Returns the icon used to represent non-leaf nodes that are expanded.
     */
    public SIcon getOpenIcon() {
        return openIcon;
    }

    /**
     * Sets the icon used to represent non-leaf nodes that are not expanded.
     */
    public void setClosedIcon(SIcon newIcon) {
        SIcon oldVal = this.closedIcon;
        closedIcon = newIcon;
        propertyChangeSupport.firePropertyChange("closedIcon", oldVal, this.closedIcon);
    }

    /**
     * Returns the icon used to represent non-leaf nodes that are not
     * expanded.
     */
    public SIcon getClosedIcon() {
        return closedIcon;
    }

    /**
     * Sets the icon used to represent leaf nodes.
     */
    public void setLeafIcon(SIcon newIcon) {
        SIcon oldVal = this.leafIcon;
        leafIcon = newIcon;
        propertyChangeSupport.firePropertyChange("leafIcon", oldVal, this.leafIcon);
    }

    /**
     * Returns the icon used to represent leaf nodes.
     */
    public SIcon getLeafIcon() {
        return leafIcon;
    }

    /**
     * Style to use for the foreground for selected nodes.
     */
    protected String selectionStyle = null;

    /**
     * Style to use for the foreground for non-selected nodes.
     */
    protected String nonSelectionStyle = null;

    @Override
    public SComponent getTreeCellRendererComponent(STree tree,
                                                   Object value,
                                                   boolean selected,
                                                   boolean expanded,
                                                   boolean leaf,
                                                   int row,
                                                   boolean hasFocus) {
        setNameRaw(name(tree, row));
        String string = value != null ? value.toString() : null;

        if (value == null || string == null || string.length() == 0) {
            setText(null);
        } else {
            setText(string);
            setToolTipText(string);
        }

        if (!tree.isEnabled()) {
            setEnabled(false);
            if (leaf) {
                setDisabledIcon(getLeafIcon());
            } else if (expanded) {
                setDisabledIcon(openIcon);
            } else {
                setDisabledIcon(closedIcon);
            }
        } else {
            setEnabled(true);
            if (leaf) {
                setIcon(getLeafIcon());
            } else if (expanded) {
                setIcon(openIcon);
            } else {
                setIcon(closedIcon);
            }
        }

        if (getStyle() == null)
            setStyle(tree.getStyle());
        if (getDynamicStyles() == null)
            setDynamicStyles(tree.getDynamicStyles());

        return this;
    }

    protected String name(SComponent component, int row) {
        nameBuffer.setLength(0);
        nameBuffer.append(component.getName()).append('_').append(row);
        return nameBuffer.toString();
    }

    /**
     * Sets the style the cell is drawn with when the cell is selected.
     */
    public void setSelectionStyle(String newStyle) {
        String oldVal = this.selectionStyle;
        selectionStyle = newStyle;
        propertyChangeSupport.firePropertyChange("selectionStyle", oldVal, this.selectionStyle);
    }

    /**
     * Returns the style the cell is drawn with when the cell is selected.
     */
    public String getSelectionStyle() {
        return selectionStyle;
    }

    /**
     * Sets the style the cell is drawn with when the cell isn't selected.
     */
    public void setNonSelectionStyle(String newStyle) {
        String oldVal = this.nonSelectionStyle;
        nonSelectionStyle = newStyle;
        propertyChangeSupport.firePropertyChange("nonSelectionStyle", oldVal, this.nonSelectionStyle);
    }

    /**
     * Returns the style the cell is drawn with when the cell isn't selected.
     */
    public String getNonSelectionStyle() {
        return nonSelectionStyle;
    }

}