com.anrisoftware.prefdialog.core.AbstractTitleField Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2016 Erwin Müller 
 *
 * This file is part of prefdialog-core.
 *
 * prefdialog-core 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 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-core 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 Lesser General Public License
 * along with prefdialog-core. If not, see .
 */
package com.anrisoftware.prefdialog.core;

import static info.clearthought.layout.TableLayoutConstants.FILL;
import static info.clearthought.layout.TableLayoutConstants.PREFERRED;
import static java.lang.String.format;
import static org.apache.commons.lang3.StringUtils.isEmpty;
import info.clearthought.layout.TableLayout;

import java.awt.Component;
import java.awt.Container;
import java.util.Locale;

import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingConstants;

import com.anrisoftware.globalpom.textposition.TextPosition;
import com.anrisoftware.resources.images.api.IconSize;
import com.anrisoftware.resources.images.api.Images;
import com.anrisoftware.resources.texts.api.Texts;

/**
 * Sets a title label on top of the field. The title can show the icon if the
 * correct text position is set.
 *
 * @see AbstractContainerField
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
@SuppressWarnings("serial")
public abstract class AbstractTitleField
        extends AbstractContainerField {

    /**
     * Suffix for the title label for the field. The name of the title label
     * will be {@code -title}, {@code } is the name of the field.
     */
    public static final String TITLE_NAME = "title";

    private final JLabel titleLabel;

    private final TableLayout layout;

    /**
     * @see AbstractContainerField#AbstractContainerField(Component, Object,
     *      String)
     */
    protected AbstractTitleField(ComponentType component, Object parentObject,
            String fieldName) {
        super(component, parentObject, fieldName);
        this.titleLabel = new JLabel("(title):");
        this.layout = createLayout();
        setup();
    }

    private void setup() {
        setupContainer();
        setupTitleLabel();
    }

    private void setupContainer() {
        Container container = getContainer();
        container.removeAll();
        container.setLayout(layout);
        container.add(titleLabel, "0, 0");
        container.add(getComponent(), "0, 1");
    }

    private TableLayout createLayout() {
        double[] col = { FILL };
        double[] row = { PREFERRED, PREFERRED };
        return new TableLayout(col, row);
    }

    private void setupTitleLabel() {
        titleLabel.setLabelFor(getComponent());
    }

    /**
     * Sets the name of the title label to
     * <name>-{@value #TITLE_NAME}, with <name> being
     * the name of the component.
     */
    @Override
    public void setName(String name) {
        super.setName(name);
        titleLabel.setName(format("%s-%s", name, TITLE_NAME));
    }

    @Override
    public void setMnemonic(int mnemonic) {
        super.setMnemonic(mnemonic);
        titleLabel.setDisplayedMnemonic(mnemonic);
    }

    @Override
    public void setMnemonicIndex(int index) {
        super.setMnemonicIndex(index);
        if (titleLabel.getText() != null) {
            titleLabel.setDisplayedMnemonicIndex(index);
        }
    }

    /**
     * Enabled or disables the title label with the component.
     */
    @Override
    public void setEnabled(boolean enabled) {
        super.setEnabled(enabled);
        titleLabel.setEnabled(enabled);
    }

    @Override
    public void setTitlePosition(TextPosition position) {
        super.setTitlePosition(position);
        switch (position) {
        case ICON_ONLY:
            titleLabel.setText(null);
            break;
        case TEXT_ALONGSIDE_ICON:
            updateTitleResource();
            updateIconResource();
            titleLabel.setVerticalTextPosition(SwingConstants.CENTER);
            break;
        case TEXT_ONLY:
            updateTitleResource();
            titleLabel.setIcon(null);
            break;
        case TEXT_UNDER_ICON:
            updateIconResource();
            updateTitleResource();
            titleLabel.setVerticalTextPosition(SwingConstants.BOTTOM);
            break;
        default:
            break;
        }
    }

    @Override
    public void setIconSize(IconSize size) {
        super.setIconSize(size);
        updateIconResource();
    }

    @Override
    public void setLocale(Locale locale) {
        super.setLocale(locale);
        updateTextsResources();
        updateIconResource();
    }

    @Override
    public void setImages(Images images) {
        super.setImages(images);
        updateIconResource();
    }

    private void updateIconResource() {
        titleLabel.setIcon(getIcon());
    }

    @Override
    public void setTexts(Texts texts) {
        super.setTexts(texts);
        updateTextsResources();
    }

    private void updateTextsResources() {
        updateTitleResource();
    }

    private void updateTitleResource() {
        if (isShowTitle()) {
            titleLabel.setText(getTitleLabelText());
            updateMnemonic();
        } else {
            titleLabel.setText(null);
        }
    }

    private void updateMnemonic() {
        Integer mnemonic = getMnemonic();
        if (mnemonic != null) {
            titleLabel.setDisplayedMnemonic(mnemonic);
        }
        int index = getMnemonicIndex();
        if (index != -1) {
            titleLabel.setDisplayedMnemonicIndex(index);
        }
    }

    public String getTitleLabelText() {
        return appendColumn(getTitle());
    }

    private String appendColumn(String text) {
        if (!isEmpty(text) && !text.endsWith(":")) {
            text = text + ":";
        }
        return text;
    }

    /**
     * Returns the title label for styling.
     *
     * @return the {@link JLabel} title label.
     */
    public JLabel getTitleLabel() {
        return titleLabel;
    }

    @Override
    public void setContainer(JPanel container) {
        super.setContainer(container);
        setupContainer();
    }

    @Override
    public void setComponent(ComponentType component) {
        super.setComponent(component);
        setupContainer();
    }

}