io.github.jonestimd.swing.ComponentFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swing-extensions Show documentation
Extensions for Java Swing
There is a newer version: 1.4.5
// The MIT License (MIT)
//
// Copyright (c) 2019 Timothy D. Jones
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package io.github.jonestimd.swing;

import java.awt.Color;
import java.awt.Dimension;
import java.awt.event.KeyEvent;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import java.util.ResourceBundle;
import java.util.function.Function;
import java.util.function.Predicate;

import javax.swing.AbstractButton;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.ButtonGroup;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JRadioButton;
import javax.swing.JSeparator;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.JToggleButton;
import javax.swing.JToolBar;
import javax.swing.KeyStroke;
import javax.swing.UIManager;
import javax.swing.border.BevelBorder;
import javax.swing.border.CompoundBorder;
import javax.swing.border.EmptyBorder;
import javax.swing.plaf.synth.SynthLookAndFeel;
import javax.swing.text.JTextComponent;

import io.github.jonestimd.swing.border.OblongBorder;
import io.github.jonestimd.swing.component.BeanListComboBox;
import io.github.jonestimd.swing.component.FilterField;
import io.github.jonestimd.swing.component.IconBorder;
import io.github.jonestimd.swing.component.IconBorder.Side;
import io.github.jonestimd.swing.layout.GridBagBuilder;
import io.github.jonestimd.text.ToStringFormat;

public class ComponentFactory {
    public static final char NO_MNEMONIC = ' ';
    public static final String ACCELERATOR_DELIMITER = Optional.ofNullable(UIManager.getString("MenuItem.acceleratorDelimiter")).orElse("+");
    public static final String TOOLBAR_BUTTON_ACTION_KEY = "doClick";
    public static final int LABEL_GAP = 5;

    public static JRadioButton[] newRadioButtonGroup(ResourceBundle bundle, String ... mnemonicAndNameKeys) {
        ButtonGroup group = new ButtonGroup();
        JRadioButton[] buttons = new JRadioButton[mnemonicAndNameKeys.length];
        for (int i = 0; i < mnemonicAndNameKeys.length; i++) {
            buttons[i] = newToggleButton(JRadioButton::new, bundle, mnemonicAndNameKeys[i]);
            group.add(buttons[i]);
        }
        return buttons;
    }

    public static JCheckBox newCheckBox(ResourceBundle bundle, String mnemonicAndNameKey) {
        return newToggleButton(JCheckBox::new, bundle, mnemonicAndNameKey);
    }

    private static  T newToggleButton(Function buttonFactory, ResourceBundle bundle, String mnemonicAndNameKey) {
        String mnemonicAndName = bundle.getString(mnemonicAndNameKey);
        T button = buttonFactory.apply(mnemonicAndName.substring(1));
        if (mnemonicAndName.charAt(0) != NO_MNEMONIC) {
            button.setMnemonic(mnemonicAndName.charAt(0));
        }
        return button;
    }

    public static JTextArea newValidationStatusArea(int rows, ResourceBundle bundle) {
        JTextArea statusArea = new JTextArea();
        statusArea.setEditable(false);
        statusArea.setRows(rows);
        statusArea.setBorder(new CompoundBorder(new BevelBorder(BevelBorder.LOWERED), new EmptyBorder(2, 2, 2, 2)));
        statusArea.setMaximumSize(new Dimension(Integer.MAX_VALUE, statusArea.getHeight()));
        statusArea.setBackground(SwingResource.VALIDATION_MESSAGE_BACKGROUND.getColor(bundle));
        return statusArea;
    }

    public static JComponent newFormSeparator(String label) {
        Box box = Box.createHorizontalBox();
        box.add(createFormSeparator());
        box.add(Box.createHorizontalStrut(LABEL_GAP));
        box.add(new LabelBuilder().name(label).bold().get());
        box.add(Box.createHorizontalStrut(LABEL_GAP));
        box.add(createFormSeparator());
        return box;
    }

    private static JSeparator createFormSeparator() {
        JSeparator separator = new JSeparator(JSeparator.HORIZONTAL);
        separator.setAlignmentY(0f);
        return separator;
    }

    public static JSeparator newMenuBarSeparator() {
        JSeparator separator = new JSeparator(JSeparator.VERTICAL);
        separator.setMaximumSize(new Dimension(separator.getPreferredSize().width, Integer.MAX_VALUE));
        return separator;
    }

    public static JToolBar newMenuToolBar() {
        JToolBar toolbar = new JToolBar(JToolBar.HORIZONTAL);
        toolbar.setFloatable(false);
        toolbar.setRollover(true);
        toolbar.setBorderPainted(false);
        if (UIManager.getLookAndFeel() instanceof SynthLookAndFeel) {
            toolbar.setLayout(new BoxLayout(toolbar, BoxLayout.X_AXIS));
        }
        return toolbar;
    }

    /**
     * Creates a toggle button for a toolbar. Sets the button's tooltip text using the button's text and accelerator.
     * @param action the button action (should have text and an icon)
     * @return the new button
     * @see Action#ACCELERATOR_KEY
     */
    public static JToggleButton newToolbarToggleButton(Action action) {
        return initToolbarButton(action, new JToggleButton(action));
    }

    /**
     * Creates a button for a toolbar. Sets the button's tooltip text using the action's text and accelerator key.
     * @param action the button action (should have text and an icon)
     * @return a new non-focusable button with {@code null} text
     * @see Action#ACCELERATOR_KEY
     */
    public static JButton newToolbarButton(Action action) {
        return initToolbarButton(action, new JButton(action));
    }

    private static  T initToolbarButton(Action action, T button) {
        String tooltip = button.getText();
        KeyStroke accelerator = (KeyStroke) action.getValue(Action.ACCELERATOR_KEY);
        if (accelerator != null) {
            button.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(accelerator, TOOLBAR_BUTTON_ACTION_KEY);
            button.getActionMap().put(TOOLBAR_BUTTON_ACTION_KEY, action);
            StringBuilder acceleratorKey = new StringBuilder();
            if (accelerator.getModifiers() > 0) {
                acceleratorKey.append(KeyEvent.getKeyModifiersText(accelerator.getModifiers()));
                acceleratorKey.append(ACCELERATOR_DELIMITER);
            }
            if (accelerator.getKeyCode() != 0) {
                acceleratorKey.append(KeyEvent.getKeyText(accelerator.getKeyCode()));
            }
            else {
                acceleratorKey.append(accelerator.getKeyChar());
            }
            tooltip += String.format(SwingResource.BUTTON_TOOLTIP_ACCELERATOR_FORMAT.getString(), acceleratorKey.toString());
        }
        button.setToolTipText(tooltip);
        button.setText(null);
        button.setFocusable(false);
        return button;
    }

    public static JMenu newMenu(ResourceBundle bundle, String mnemonicAndNameKey) {
        String mnemonicAndName = bundle.getString(mnemonicAndNameKey);
        JMenu menu = new JMenu(mnemonicAndName.substring(1));
        if (mnemonicAndName.charAt(0) != NO_MNEMONIC) menu.setMnemonic(mnemonicAndName.charAt(0));
        menu.putClientProperty(ClientProperty.MNEMONIC_AND_NAME_KEY, mnemonicAndNameKey);
        return menu;
    }

    /**
     * Create a {@link JTextField} with an {@link OblongBorder} and an {@link IconBorder} using the filter icon.
     */
    public JTextField newFilterField() {
        return initializeFilterField(new JTextField(), 0, 0);
    }

    /**
     * Create a {@link FilterField} with an {@link OblongBorder} and an {@link IconBorder} using the filter icon.
     * @param predicateFactory filter string parser
     * @param paddingTop padding between top of border and input field
     * @param paddingBottom padding between bottom of border and input field
     */
    public  FilterField newFilterField(Function> predicateFactory, int paddingTop, int paddingBottom) {
        return initializeFilterField(FilterField.builder(predicateFactory).build(), paddingTop, paddingBottom);
    }

    private  T initializeFilterField(T field, int paddingTop, int paddingBottom) {
        Icon filterIcon = ComponentResources.lookupIcon("filter.iconImage");
        field.setBorder(new CompoundBorder(new OblongBorder(1, Color.GRAY, paddingTop, 4, paddingBottom, 0), new IconBorder(Side.LEFT, filterIcon)));
        return field;
    }

    /**
     * Create a component for displaying a summary (e.g. total) at the bottom of a table.  The right border will provide an
     * offset to account for a vertical scroll bar on the table.
     * @param mnemonicAndName label for the summary
     * @param summary the summary information
     * @return a component with the label and summary on the right
     */
    public static JComponent newTableSummaryPanel(String mnemonicAndName, JComponent summary) {
        JLabel label = new LabelBuilder().mnemonicAndName(mnemonicAndName).bold().get();
        Box summaryPanel = Box.createHorizontalBox();
        summaryPanel.add(Box.createHorizontalGlue());
        summaryPanel.add(label);
        summaryPanel.add(Box.createHorizontalStrut(GridBagBuilder.RELATED_GAP));
        summaryPanel.add(summary);
        summaryPanel.setBorder(BorderFactory.createEmptyBorder(2, 2, 2, UIManager.getInt("ScrollBar.width")));
        return summaryPanel;
    }

    public static > BeanListComboBox newComboBox(Class enumClass, String requiredMessage) {
        return newComboBox(Arrays.asList(enumClass.getEnumConstants()), requiredMessage);
    }

    public static > BeanListComboBox newComboBox(List items, String requiredMessage) {
        return BeanListComboBox.builder(new ToStringFormat(), items).required(requiredMessage).get();
    }
}