org.tinymediamanager.ui.tvshows.settings.TvShowSubtitleSettingsPanel.java Source code

Java tutorial

Introduction

Here is the source code for org.tinymediamanager.ui.tvshows.settings.TvShowSubtitleSettingsPanel.java

Source

/*
 * Copyright 2012 - 2016 Manuel Laggner
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.tinymediamanager.ui.tvshows.settings;

import java.awt.Canvas;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.image.BufferedImage;
import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;

import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.JTextPane;
import javax.swing.ScrollPaneConstants;
import javax.swing.UIManager;
import javax.swing.border.TitledBorder;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.event.TableModelEvent;
import javax.swing.event.TableModelListener;
import javax.swing.text.html.HTMLDocument;
import javax.swing.text.html.HTMLEditorKit;

import org.apache.commons.lang3.StringUtils;
import org.imgscalr.Scalr;
import org.jdesktop.beansbinding.AutoBinding;
import org.jdesktop.beansbinding.BeanProperty;
import org.jdesktop.beansbinding.Bindings;
import org.jdesktop.beansbinding.AutoBinding.UpdateStrategy;
import org.jdesktop.observablecollections.ObservableCollections;
import org.jdesktop.swingbinding.JTableBinding;
import org.jdesktop.swingbinding.SwingBindings;
import org.tinymediamanager.core.AbstractModelObject;
import org.tinymediamanager.core.ImageCache;
import org.tinymediamanager.core.tvshow.TvShowList;
import org.tinymediamanager.core.tvshow.TvShowModuleManager;
import org.tinymediamanager.core.tvshow.TvShowSettings;
import org.tinymediamanager.scraper.MediaScraper;
import org.tinymediamanager.scraper.entities.MediaLanguages;
import org.tinymediamanager.scraper.mediaprovider.IMediaProvider;
import org.tinymediamanager.ui.TableColumnResizer;
import org.tinymediamanager.ui.UTF8Control;
import org.tinymediamanager.ui.panels.MediaScraperConfigurationPanel;
import org.tinymediamanager.ui.panels.ScrollablePanel;

import com.jgoodies.forms.layout.ColumnSpec;
import com.jgoodies.forms.layout.FormLayout;
import com.jgoodies.forms.layout.FormSpecs;
import com.jgoodies.forms.layout.RowSpec;

/**
 * The Class TvShowSubtitleSettingsPanel. To maintain subtitle related settings
 * 
 * @author Manuel Laggner
 */
public class TvShowSubtitleSettingsPanel extends ScrollablePanel {
    private static final long serialVersionUID = -1607146878528487625L;
    /** @wbp.nls.resourceBundle messages */
    private static final ResourceBundle BUNDLE = ResourceBundle.getBundle("messages", new UTF8Control()); //$NON-NLS-1$

    private TvShowSettings settings = TvShowModuleManager.SETTINGS;
    private List<SubtitleScraper> scrapers = ObservableCollections.observableList(new ArrayList<SubtitleScraper>());
    private JTable tableScraper;
    private JTextPane tpScraperDescription;
    private JPanel panelScraperOptions;
    private JComboBox cbScraperLanguage;

    public TvShowSubtitleSettingsPanel() {
        initComponents();
    }

    private void initComponents() {
        // data init
        List<String> enabledSubtitleProviders = settings.getTvShowSubtitleScrapers();
        int selectedIndex = -1;
        int counter = 0;
        for (MediaScraper scraper : TvShowList.getInstance().getAvailableSubtitleScrapers()) {
            SubtitleScraper subtitleScraper = new SubtitleScraper(scraper);
            if (enabledSubtitleProviders.contains(subtitleScraper.getScraperId())) {
                subtitleScraper.active = true;
                if (selectedIndex < 0) {
                    selectedIndex = counter;
                }
            }
            scrapers.add(subtitleScraper);
            counter++;
        }

        // UI init
        setLayout(new FormLayout(
                new ColumnSpec[] { FormSpecs.RELATED_GAP_COLSPEC, FormSpecs.DEFAULT_COLSPEC,
                        FormSpecs.RELATED_GAP_COLSPEC, FormSpecs.DEFAULT_COLSPEC, FormSpecs.RELATED_GAP_COLSPEC,
                        ColumnSpec.decode("default:grow"), FormSpecs.RELATED_GAP_COLSPEC, },
                new RowSpec[] { FormSpecs.RELATED_GAP_ROWSPEC, RowSpec.decode("default:grow"),
                        FormSpecs.RELATED_GAP_ROWSPEC, FormSpecs.DEFAULT_ROWSPEC,
                        FormSpecs.RELATED_GAP_ROWSPEC, }));

        JPanel panelSubtitleScrapers = new JPanel();
        panelSubtitleScrapers.setBorder(new TitledBorder(UIManager.getBorder("TitledBorder.border"),
                BUNDLE.getString("scraper.subtitle"), TitledBorder.LEADING, TitledBorder.TOP, null, null)); // $NON-NLS-1$
        add(panelSubtitleScrapers, "2, 2, 5, 1, fill, fill");
        panelSubtitleScrapers.setLayout(new FormLayout(
                new ColumnSpec[] { FormSpecs.RELATED_GAP_COLSPEC, ColumnSpec.decode("100dlu:grow"),
                        FormSpecs.RELATED_GAP_COLSPEC, ColumnSpec.decode("200dlu:grow"),
                        FormSpecs.RELATED_GAP_COLSPEC, },
                new RowSpec[] { FormSpecs.RELATED_GAP_ROWSPEC, RowSpec.decode("100dlu:grow"), }));

        final JScrollPane scrollPaneScraperDetails = new JScrollPane();
        scrollPaneScraperDetails.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        scrollPaneScraperDetails.setBorder(null);
        panelSubtitleScrapers.add(scrollPaneScraperDetails, "4, 1, 1, 2, fill, fill");

        JPanel panelScraperDetails = new JPanel();
        scrollPaneScraperDetails.setViewportView(panelScraperDetails);
        panelScraperDetails.setLayout(new FormLayout(new ColumnSpec[] { ColumnSpec.decode("default:grow"), },
                new RowSpec[] { RowSpec.decode("default:grow"), FormSpecs.RELATED_GAP_ROWSPEC,
                        FormSpecs.DEFAULT_ROWSPEC, }));
        {
            // add a CSS rule to force body tags to use the default label font
            // instead of the value in javax.swing.text.html.default.csss
            Font font = UIManager.getFont("Label.font");
            String bodyRule = "body { font-family: " + font.getFamily() + "; " + "font-size: " + font.getSize()
                    + "pt; }";
            tpScraperDescription = new JTextPane();
            tpScraperDescription.setOpaque(false);
            tpScraperDescription.setEditorKit(new HTMLEditorKit());
            ((HTMLDocument) tpScraperDescription.getDocument()).getStyleSheet().addRule(bodyRule);
            panelScraperDetails.add(tpScraperDescription, "1, 1, fill, top");
        }
        panelScraperOptions = new ScrollablePanel();
        panelScraperOptions.setLayout(new FlowLayout(FlowLayout.LEFT));
        panelScraperDetails.add(panelScraperOptions, "1, 3, fill, top");

        JScrollPane scrollPaneScraper = new JScrollPane();
        panelSubtitleScrapers.add(scrollPaneScraper, "2, 2, fill, fill");

        tableScraper = new JTable();
        tableScraper.setRowHeight(29);
        scrollPaneScraper.setViewportView(tableScraper);

        final JLabel lblScraperLanguage = new JLabel(BUNDLE.getString("Settings.preferredLanguage")); //$NON-NLS-1$
        add(lblScraperLanguage, "2, 4, right, default");

        cbScraperLanguage = new JComboBox(MediaLanguages.values());
        add(cbScraperLanguage, "4, 4, fill, default");

        initDataBindings();

        // adjust table columns
        // Checkbox and Logo shall have minimal width
        TableColumnResizer.setMaxWidthForColumn(tableScraper, 0, 2);
        TableColumnResizer.setMaxWidthForColumn(tableScraper, 1, 2);
        TableColumnResizer.adjustColumnPreferredWidths(tableScraper, 5);

        tableScraper.getModel().addTableModelListener(new TableModelListener() {
            @Override
            public void tableChanged(TableModelEvent arg0) {
                // click on the checkbox
                if (arg0.getColumn() == 0) {
                    int row = arg0.getFirstRow();
                    SubtitleScraper changedScraper = scrapers.get(row);
                    if (changedScraper.active) {
                        settings.addTvShowSubtitleScraper(changedScraper.getScraperId());
                    } else {
                        settings.removeTvShowSubtitleScraper(changedScraper.getScraperId());
                    }
                }
            }
        });

        // implement selection listener to load settings
        tableScraper.getSelectionModel().addListSelectionListener(new ListSelectionListener() {
            @Override
            public void valueChanged(ListSelectionEvent e) {
                int index = tableScraper.convertRowIndexToModel(tableScraper.getSelectedRow());
                if (index > -1) {
                    panelScraperOptions.removeAll();
                    if (scrapers.get(index).getMediaProvider().getProviderInfo().getConfig().hasConfig()) {
                        panelScraperOptions
                                .add(new MediaScraperConfigurationPanel(scrapers.get(index).getMediaProvider()));
                    }
                    panelScraperOptions.revalidate();
                }
            }
        });

        // select default tv show subtitle scraper
        if (selectedIndex < 0) {
            selectedIndex = 0;
        }
        if (counter > 0) {
            tableScraper.getSelectionModel().setSelectionInterval(selectedIndex, selectedIndex);
        }
    }

    /*****************************************************************************************************
     * helper classes
     ****************************************************************************************************/
    public class SubtitleScraper extends AbstractModelObject {
        private MediaScraper scraper;
        private Icon scraperLogo;
        private boolean active;

        public SubtitleScraper(MediaScraper scraper) {
            this.scraper = scraper;
            if (scraper.getMediaProvider().getProviderInfo().getProviderLogo() == null) {
                scraperLogo = new ImageIcon();
            } else {
                scraperLogo = getScaledIcon(
                        new ImageIcon(scraper.getMediaProvider().getProviderInfo().getProviderLogo()));
            }
        }

        private ImageIcon getScaledIcon(ImageIcon original) {
            Canvas c = new Canvas();
            FontMetrics fm = c.getFontMetrics(getFont());

            int height = (int) (fm.getHeight() * 2f);
            int width = original.getIconWidth() / original.getIconHeight() * height;

            BufferedImage scaledImage = Scalr.resize(ImageCache.createImage(original.getImage()),
                    Scalr.Method.QUALITY, Scalr.Mode.AUTOMATIC, width, height, Scalr.OP_ANTIALIAS);
            return new ImageIcon(scaledImage);
        }

        public String getScraperId() {
            return scraper.getId();
        }

        public String getScraperName() {
            return scraper.getName() + " - " + scraper.getVersion();
        }

        public String getScraperDescription() {
            // first try to get the localized version
            String description = null;
            try {
                description = BUNDLE.getString("scraper." + scraper.getId() + ".hint"); //$NON-NLS-1$
            } catch (Exception ignored) {
            }

            if (StringUtils.isBlank(description)) {
                // try to get a scraper text
                description = scraper.getDescription();
            }

            return description;
        }

        public Icon getScraperLogo() {
            return scraperLogo;
        }

        public Boolean getActive() {
            return active;
        }

        public void setActive(Boolean newValue) {
            Boolean oldValue = this.active;
            this.active = newValue;
            firePropertyChange("active", oldValue, newValue);
        }

        public IMediaProvider getMediaProvider() {
            return scraper.getMediaProvider();
        }
    }

    protected void initDataBindings() {
        JTableBinding<SubtitleScraper, List<SubtitleScraper>, JTable> jTableBinding = SwingBindings
                .createJTableBinding(UpdateStrategy.READ_WRITE, scrapers, tableScraper);
        //
        BeanProperty<SubtitleScraper, Boolean> subtitleScraperBeanProperty = BeanProperty.create("active");
        jTableBinding.addColumnBinding(subtitleScraperBeanProperty).setColumnName("Active")
                .setColumnClass(Boolean.class);
        //
        BeanProperty<SubtitleScraper, Icon> subtitleScraperBeanProperty_1 = BeanProperty.create("scraperLogo");
        jTableBinding.addColumnBinding(subtitleScraperBeanProperty_1).setColumnName("Logo").setEditable(false)
                .setColumnClass(ImageIcon.class);
        //
        BeanProperty<SubtitleScraper, String> subtitleScraperBeanProperty_2 = BeanProperty.create("scraperName");
        jTableBinding.addColumnBinding(subtitleScraperBeanProperty_2).setColumnName("Name").setEditable(false)
                .setColumnClass(String.class);
        //
        jTableBinding.bind();
        //
        BeanProperty<JTable, String> jTableBeanProperty = BeanProperty.create("selectedElement.scraperDescription");
        BeanProperty<JTextPane, String> jTextPaneBeanProperty = BeanProperty.create("text");
        AutoBinding<JTable, String, JTextPane, String> autoBinding = Bindings.createAutoBinding(UpdateStrategy.READ,
                tableScraper, jTableBeanProperty, tpScraperDescription, jTextPaneBeanProperty);
        autoBinding.bind();
        //
        BeanProperty<TvShowSettings, MediaLanguages> tvShowSettingsBeanProperty = BeanProperty
                .create("subtitleScraperLanguage");
        BeanProperty<JComboBox, Object> jComboBoxBeanProperty = BeanProperty.create("selectedItem");
        AutoBinding<TvShowSettings, MediaLanguages, JComboBox, Object> autoBinding_1 = Bindings.createAutoBinding(
                UpdateStrategy.READ_WRITE, settings, tvShowSettingsBeanProperty, cbScraperLanguage,
                jComboBoxBeanProperty);
        autoBinding_1.bind();
    }
}