com.alee.laf.table.AbstractTableDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * 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 .
 */

package com.alee.laf.table;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.managers.style.AbstractComponentDescriptor;
import com.alee.managers.style.StyleId;
import com.alee.utils.ReflectUtils;

import javax.swing.*;
import javax.swing.table.JTableHeader;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import java.awt.*;
import java.util.Enumeration;
import java.util.Hashtable;

/**
 * Abstract descriptor for {@link JTable} component.
 * Extend this class for creating custom {@link JTable} descriptors.
 *
 * @param  {@link JTable} type
 * @param  base {@link WebTableUI} type
 * @param  {@link ITablePainter} type
 * @author Mikle Garin
 * @see How to use StyleManager
 * @see com.alee.managers.style.StyleManager
 * @see com.alee.managers.style.StyleManager#registerComponentDescriptor(com.alee.managers.style.ComponentDescriptor)
 * @see com.alee.managers.style.StyleManager#unregisterComponentDescriptor(com.alee.managers.style.ComponentDescriptor)
 */
public abstract class AbstractTableDescriptor
        extends AbstractComponentDescriptor
{
    /**
     * Constructs new {@link AbstractTableDescriptor}.
     *
     * @param id                  {@link JTable} identifier
     * @param componentClass      {@link JTable} {@link Class}
     * @param uiClassId           {@link WebTableUI} {@link Class} identifier
     * @param baseUIClass         base {@link WebTableUI} {@link Class} applicable to {@link JTable}
     * @param uiClass             {@link WebTableUI} {@link Class} used for {@link JTable} by default
     * @param painterInterface    {@link ITablePainter} interface {@link Class}
     * @param painterClass        {@link ITablePainter} implementation {@link Class}
     * @param painterAdapterClass adapter for {@link ITablePainter}
     * @param defaultStyleId      {@link JTable} default {@link StyleId}
     */
    public AbstractTableDescriptor ( @NotNull final String id, @NotNull final Class componentClass, @NotNull final String uiClassId,
                                     @NotNull final Class baseUIClass, @NotNull final Class uiClass,
                                     @NotNull final Class painterInterface, @NotNull final Class painterClass,
                                     @NotNull final Class painterAdapterClass, @NotNull final StyleId defaultStyleId )
    {
        super ( id, componentClass, uiClassId, baseUIClass, uiClass, painterInterface, painterClass, painterAdapterClass, defaultStyleId );
    }

    @Override
    public void updateUI ( @NotNull final C component )
    {
        // Update the UIs of the cell renderers, cell editors and header renderers.
        final TableColumnModel cm = component.getColumnModel ();
        for ( int column = 0; column < cm.getColumnCount (); column++ )
        {
            final TableColumn aColumn = cm.getColumn ( column );
            updateRendererOrEditorUI ( aColumn.getCellRenderer () );
            updateRendererOrEditorUI ( aColumn.getCellEditor () );
            updateRendererOrEditorUI ( aColumn.getHeaderRenderer () );
        }

        // Update the UIs of all the default renderers.
        final Hashtable defaultRenderersByColumnClass = ReflectUtils.getFieldValueSafely ( component, "defaultRenderersByColumnClass" );
        if ( defaultRenderersByColumnClass != null )
        {
            final Enumeration defaultRenderers = defaultRenderersByColumnClass.elements ();
            while ( defaultRenderers.hasMoreElements () )
            {
                updateRendererOrEditorUI ( defaultRenderers.nextElement () );
            }
        }

        // Update the UIs of all the default editors.
        final Hashtable defaultEditorsByColumnClass = ReflectUtils.getFieldValueSafely ( component, "defaultEditorsByColumnClass" );
        if ( defaultEditorsByColumnClass != null )
        {
            final Enumeration defaultEditors = defaultEditorsByColumnClass.elements ();
            while ( defaultEditors.hasMoreElements () )
            {
                updateRendererOrEditorUI ( defaultEditors.nextElement () );
            }
        }

        // Updating table header UI
        final JTableHeader header = component.getTableHeader ();
        if ( header != null )
        {
            header.updateUI ();
        }

        // Configuring enclosing scroll pane
        if ( component instanceof WebTable )
        {
            // Configuring through custom WebTable method
            ( ( WebTable ) component ).configureScrollPane ();
        }
        else
        {
            // Configuring through basic JTable method
            ReflectUtils.callMethodSafely ( component, "configureEnclosingScrollPaneUI" );
        }

        // Updating component UI
        super.updateUI ( component );
    }

    /**
     * Updates renderer or editor component tree UIs.
     *
     * @param rendererOrEditor renderer or editor component
     */
    private void updateRendererOrEditorUI ( @Nullable final Object rendererOrEditor )
    {
        if ( rendererOrEditor != null )
        {
            Component component = null;
            if ( rendererOrEditor instanceof Component )
            {
                component = ( Component ) rendererOrEditor;
            }
            if ( rendererOrEditor instanceof DefaultCellEditor )
            {
                component = ( ( DefaultCellEditor ) rendererOrEditor ).getComponent ();
            }
            if ( component != null )
            {
                SwingUtilities.updateComponentTreeUI ( component );
            }
        }
    }
}