/**
* DataCleaner (community edition)
* Copyright (C) 2014 Neopost - Customer Information Management
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program 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 Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.datacleaner.widgets.tabs;
import java.awt.BorderLayout;
import java.awt.Color;
import java.util.ArrayList;
import java.util.List;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JScrollPane;
import javax.swing.SwingConstants;
import javax.swing.border.Border;
import javax.swing.border.CompoundBorder;
import javax.swing.border.EmptyBorder;
import org.datacleaner.panels.DCPanel;
import org.datacleaner.util.ImageManager;
import org.datacleaner.util.WidgetFactory;
import org.datacleaner.util.WidgetUtils;
import org.datacleaner.windows.ResultWindow;
import org.jdesktop.swingx.JXCollapsiblePane;
import org.jdesktop.swingx.VerticalLayout;
/**
* The vertical tabbed pane used in the {@link ResultWindow} to present the
* available analyzer results
*/
public class VerticalTabbedPane extends DCPanel {
public interface Listener {
void stateChanged(int newIndex, Tab<?> newTab);
}
private static final long serialVersionUID = 1L;
private static final ImageManager imageManager = ImageManager.get();
private static final Color COLOR_SELECTED_FOREGROUND = WidgetUtils.BG_COLOR_BLUE_DARK;
private static final Color COLOR_SELECTED_BACKGROUND = WidgetUtils.BG_COLOR_LESS_BRIGHT;
private static final Border BORDER_TABS =
new CompoundBorder(WidgetUtils.BORDER_LIST_ITEM_SUBTLE, new EmptyBorder(10, 4, 10, 4));
private final List<VerticalTab<?>> _tabs;
private final DCPanel _leftPanel;
private JComponent _currentContent;
private List<Listener> changeListeners = new ArrayList<>();
public VerticalTabbedPane() {
super();
_tabs = new ArrayList<>();
_leftPanel = new DCPanel();
_leftPanel.setLayout(new VerticalLayout(0));
setLayout(new BorderLayout());
add(wrapInCollapsiblePane(wrapInScrollPane(_leftPanel)), BorderLayout.WEST);
}
protected JComponent wrapInScrollPane(final JComponent panel) {
final JScrollPane scroll = WidgetUtils.scrolleable(panel);
scroll.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
return scroll;
}
protected JComponent wrapInCollapsiblePane(final JComponent panel) {
final JXCollapsiblePane collapsiblePane = new JXCollapsiblePane(JXCollapsiblePane.Direction.LEFT);
collapsiblePane.getContentPane().setBackground(WidgetUtils.COLOR_DEFAULT_BACKGROUND);
collapsiblePane.add(panel);
collapsiblePane.setAnimated(false);
final JButton toggleTabViewButton =
new JButton(imageManager.getImageIcon("images/widgets/vertical-tabs-collapse.png"));
toggleTabViewButton.setBorder(null);
toggleTabViewButton.setOpaque(false);
toggleTabViewButton.setContentAreaFilled(false);
toggleTabViewButton.addActionListener(e -> {
final boolean collapsed = collapsiblePane.isCollapsed();
if (collapsed) {
toggleTabViewButton.setIcon(imageManager.getImageIcon("images/widgets/vertical-tabs-collapse.png"));
toggleTabViewButton.setBorder(null);
} else {
toggleTabViewButton.setIcon(imageManager.getImageIcon("images/widgets/vertical-tabs-expand.png"));
toggleTabViewButton.setBorder(new EmptyBorder(0, 2, 0, 0));
}
collapsiblePane.setCollapsed(!collapsed);
});
final DCPanel collapseButtonPanel = new DCPanel();
collapseButtonPanel.setOpaque(true);
collapseButtonPanel.setBackground(WidgetUtils.COLOR_ALTERNATIVE_BACKGROUND);
collapseButtonPanel.setLayout(new VerticalLayout(4));
collapseButtonPanel.setBorder(null);
collapseButtonPanel.add(toggleTabViewButton);
final DCPanel wrapperPanel = new DCPanel();
wrapperPanel.setLayout(new BorderLayout());
wrapperPanel.add(collapsiblePane, BorderLayout.CENTER);
wrapperPanel.add(collapseButtonPanel, BorderLayout.EAST);
return wrapperPanel;
}
public int getTabCount() {
return _tabs.size();
}
public int getSelectedIndex() {
int i = 0;
for (final VerticalTab<?> tab : _tabs) {
final JButton button = tab.getButton();
if (button.getForeground() == COLOR_SELECTED_FOREGROUND
&& button.getBackground() == COLOR_SELECTED_BACKGROUND) {
return i;
}
i++;
}
return -1;
}
public void setSelectedIndex(final int index) {
setSelectedIndex(index, true);
}
public void setSelectedIndex(final int index, final boolean scrollable) {
// reset other components
for (final VerticalTab<?> tab : _tabs) {
final JButton button = tab.getButton();
button.setForeground(null);
button.setBackground(null);
}
if (_currentContent != null) {
remove(_currentContent);
}
final VerticalTab<?> tab = _tabs.get(index);
// styling of button
final JButton button = tab.getButton();
button.setBackground(COLOR_SELECTED_BACKGROUND);
button.setForeground(COLOR_SELECTED_FOREGROUND);
// set component as content
final JComponent panel = tab.getContents();
if (scrollable) {
final JScrollPane scroll = WidgetUtils.scrolleable(panel);
scroll.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
add(scroll, BorderLayout.CENTER);
_currentContent = scroll;
} else {
add(panel, BorderLayout.CENTER);
_currentContent = panel;
}
for (final Listener listener : changeListeners) {
listener.stateChanged(index, tab);
}
updateUI();
}
public <C extends JComponent> Tab<C> addTab(final String title, final Icon icon, final C component) {
final int index = _tabs.size();
final JButton button = WidgetFactory.createDefaultButton(title, icon);
button.setHorizontalAlignment(SwingConstants.LEFT);
button.setBorder(BORDER_TABS);
button.addActionListener(e -> setSelectedIndex(index));
_leftPanel.add(button);
final VerticalTab<C> tab = new VerticalTab<>(button, component);
_tabs.add(tab);
if (index == 0) {
// the first tab automatically gets selected
button.doClick();
}
return tab;
}
public void addListener(final Listener listener) {
changeListeners.add(listener);
}
}