org.wings.table.SDefaultTableRowSelectionRenderer 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.table;

import org.wings.SComponent;
import org.wings.SLabel;
import org.wings.SResourceIcon;
import org.wings.STable;
import javax.swing.*;

/**
 * Renderer responsible for the row selection column in cases where the table
 * cannot distinguish clicks on cells as selection clicks or editing clicks.
 *
 * @author Benjamin Schmid
 */
public class SDefaultTableRowSelectionRenderer extends SLabel implements STableCellRenderer {

    public static final SResourceIcon DEFAULT_MULTI_SELECTION_ICON =
            new SResourceIcon("org/wings/icons/SelectedCheckBox.gif");

    public static final SResourceIcon DEFAULT_MULTI_NOT_SELECTION_ICON =
            new SResourceIcon("org/wings/icons/NotSelectedCheckBox.gif");

    public static final SResourceIcon DEFAULT_SINGLE_SELECTION_ICON =
            new SResourceIcon("org/wings/icons/SelectedRadioButton.gif");

    public static final SResourceIcon DEFAULT_SINGLE_NOT_SELECTION_ICON =
            new SResourceIcon("org/wings/icons/NotSelectedRadioButton.gif");

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

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

    protected SResourceIcon multiSelectionIcon = DEFAULT_MULTI_SELECTION_ICON;

    protected SResourceIcon multiNonSelectionIcon = DEFAULT_MULTI_NOT_SELECTION_ICON;

    protected SResourceIcon singleSelectionIcon = DEFAULT_SINGLE_SELECTION_ICON;

    protected SResourceIcon singleNonSelectionIcon = DEFAULT_SINGLE_NOT_SELECTION_ICON;

    /**
     * If set to true render the row selection colum with icons, otherwise simple text.
     */
    protected boolean useIcons = false;

    public SDefaultTableRowSelectionRenderer() {
    }

    @Override
    public SComponent getTableCellRendererComponent(STable table, Object value, boolean selected, int row, int col) {
        if (useIcons) {
            setText(null);
            switch (table.getSelectionMode()) {
                case ListSelectionModel.SINGLE_SELECTION:
                    setIcon(selected ? singleSelectionIcon : singleNonSelectionIcon);
                    break;
                default:
                    setIcon(selected ? multiSelectionIcon : multiNonSelectionIcon);
                    break;
            }
        } else {
            setIcon(null);
            setText(String.valueOf(row + 1));
        }
        // style
        if (selected) {
            setStyle(selectionStyle);
        } else {
            setStyle(nonSelectionStyle);
        }

        return this;
    }

    /**
     * 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;
    }

    /**
     * Sets the style the cell is drawn with when the cell isn't 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 isn't selected.
     */
    public String getSelectionStyle() {
        return selectionStyle;
    }

    /**
     * @return Icon used for selected rows in multi-selection mode for selected lines
     */
    public SResourceIcon getMultiSelectionIcon() {
        return multiSelectionIcon;
    }

    /**
     * @param multiSelectionIcon Icon used for selected rows in multi-selection mode for selected lines
     */
    public void setMultiSelectionIcon(SResourceIcon multiSelectionIcon) {
        SResourceIcon oldVal = this.multiSelectionIcon;
        this.multiSelectionIcon = multiSelectionIcon;
        propertyChangeSupport.firePropertyChange("multiSelectionIcon", oldVal, this.multiSelectionIcon);
    }

    /**
     * @return Icon used for selected rows in multi-selection mode for unselected lines
     */
    public SResourceIcon getMultiNonSelectionIcon() {
        return multiNonSelectionIcon;
    }

    /**
     * @param multiNonSelectionIcon Icon used for selected rows in multi-selection mode for unselected lines
     */
    public void setMultiNonSelectionIcon(SResourceIcon multiNonSelectionIcon) {
        SResourceIcon oldVal = this.multiNonSelectionIcon;
        this.multiNonSelectionIcon = multiNonSelectionIcon;
        propertyChangeSupport.firePropertyChange("multiNonSelectionIcon", oldVal, this.multiNonSelectionIcon);
    }

    /**
     * @return Icon used for selected rows in single-selection mode tables for selected lines
     */
    public SResourceIcon getSingleSelectionIcon() {
        return singleSelectionIcon;
    }

    /**
     * @param singleSelectionIcon Icon used for selected rows in single-selection mode tables for selected lines
     */
    public void setSingleSelectionIcon(SResourceIcon singleSelectionIcon) {
        SResourceIcon oldVal = this.singleSelectionIcon;
        this.singleSelectionIcon = singleSelectionIcon;
        propertyChangeSupport.firePropertyChange("singleSelectionIcon", oldVal, this.singleSelectionIcon);
    }

    /**
     * @return Icon used for selected rows in single-selection mode tables for unselected lines
     */
    public SResourceIcon getSingleNonSelectionIcon() {
        return singleNonSelectionIcon;
    }

    /**
     * @param singleNonSelectionIcon Icon used for selected rows in single-selection mode tables for unselected lines
     */
    public void setSingleNonSelectionIcon(SResourceIcon singleNonSelectionIcon) {
        SResourceIcon oldVal = this.singleNonSelectionIcon;
        this.singleNonSelectionIcon = singleNonSelectionIcon;
        propertyChangeSupport.firePropertyChange("singleNonSelectionIcon", oldVal, this.singleNonSelectionIcon);
    }

    /**
     * Returns if set to true render the row selection colum with icons, otherwise simple text.
     *
     * @return if set to true render the row selection colum with icons, otherwise simple text.
     */
    public boolean isUseIcons() {
        return useIcons;
    }

    /**
     * Sets if set to true render the row selection colum with icons, otherwise simple text.
     *
     * @param useIcons if set to true render the row selection colum with icons, otherwise simple text.
     */
    public void setUseIcons(boolean useIcons) {
        boolean oldVal = this.useIcons;
        this.useIcons = useIcons;
        propertyChangeSupport.firePropertyChange("useIcons", oldVal, this.useIcons);
    }
}