ca.phon.ui.layout.ButtonBarBuilder.java Source code

Introduction

Here is the source code for ca.phon.ui.layout.ButtonBarBuilder.java

Source

/*
 * Phon - An open source tool for research in phonology.
 * Copyright (C) 2005 - 2015, Gregory Hedlund <ghedlund@mun.ca> and Yvan Rose <yrose@mun.ca>
 * Dept of Linguistics, Memorial University <https://phon.ca>
 * 
 * This program 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.
 * 
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package ca.phon.ui.layout;

import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.swing.JComponent;
import javax.swing.JPanel;

import ca.phon.util.OSInfo;

import com.jgoodies.forms.layout.CellConstraints;
import com.jgoodies.forms.layout.FormLayout;

/**
 * Utility class for building dialog button bars.  The layout
 * defines three sections: right, left, and center.  Buttons
 * are added to one of these three regions and displayed in
 * the order added.
 * 
 *
 */
public class ButtonBarBuilder {

    // list of right-aligned components in order added
    private final List<WeakReference<JComponent>> rightAlignedComponents = Collections
            .synchronizedList(new ArrayList<WeakReference<JComponent>>());

    private final List<WeakReference<JComponent>> leftAlignedComponents = Collections
            .synchronizedList(new ArrayList<WeakReference<JComponent>>());

    private final List<WeakReference<JComponent>> centerAlignedComponents = Collections
            .synchronizedList(new ArrayList<WeakReference<JComponent>>());

    private WeakReference<JComponent> leftFillComponent;

    private WeakReference<JComponent> rightFillComponent;

    public ButtonBarBuilder addComponentRight(JComponent btn) {
        final WeakReference<JComponent> compRef = new WeakReference<JComponent>(btn);
        rightAlignedComponents.add(compRef);
        return this;
    }

    public ButtonBarBuilder addComponentLeft(JComponent btn) {
        final WeakReference<JComponent> compRef = new WeakReference<JComponent>(btn);
        leftAlignedComponents.add(compRef);
        return this;
    }

    public ButtonBarBuilder addComponentCenter(JComponent btn) {
        final WeakReference<JComponent> compRef = new WeakReference<JComponent>(btn);
        centerAlignedComponents.add(compRef);
        return this;
    }

    public ButtonBarBuilder setLeftFillComponent(JComponent comp) {
        final WeakReference<JComponent> compRef = new WeakReference<JComponent>(comp);
        leftFillComponent = compRef;
        return this;
    }

    public ButtonBarBuilder setRightFillComponent(JComponent comp) {
        final WeakReference<JComponent> compRef = new WeakReference<JComponent>(comp);
        rightFillComponent = compRef;
        return this;
    }

    private String createColumnSchema() {
        final StringBuilder sb = new StringBuilder();

        sb.append("left:pref");
        for (int i = 1; i < leftAlignedComponents.size(); i++) {
            sb.append(",left:pref");
        }
        sb.append(",fill:pref:grow");

        sb.append(",center:pref");
        for (int i = 1; i < centerAlignedComponents.size(); i++) {
            sb.append(",center:pref");
        }
        sb.append(",fill:pref:grow");

        sb.append(",right:pref");
        for (int i = 1; i < rightAlignedComponents.size(); i++) {
            sb.append(",right:pref");
        }

        return sb.toString();
    }

    public JComponent build() {
        final CellConstraints cc = new CellConstraints();
        final FormLayout layout = new FormLayout(createColumnSchema(), "pref");

        final JPanel retVal = new JPanel(layout);

        int colIdx = 1;

        for (int i = 0; i < leftAlignedComponents.size(); i++) {
            final WeakReference<JComponent> buttonRef = leftAlignedComponents.get(i);
            final JComponent button = buttonRef.get();

            retVal.add(button, cc.xy(colIdx, 1));
            ++colIdx;
        }
        if (colIdx == 1)
            ++colIdx;
        if (leftFillComponent != null) {
            retVal.add(leftFillComponent.get(), cc.xy(colIdx, 1));
        }
        ++colIdx;

        int oldIdx = colIdx;
        for (int i = 0; i < centerAlignedComponents.size(); i++) {
            final WeakReference<JComponent> buttonRef = centerAlignedComponents.get(i);
            final JComponent button = buttonRef.get();

            retVal.add(button, cc.xy(colIdx, 1));
            ++colIdx;
        }
        if (colIdx == oldIdx)
            ++colIdx;
        if (rightFillComponent != null) {
            retVal.add(rightFillComponent.get(), cc.xy(colIdx, 1));
        }
        ++colIdx;

        for (int i = 0; i < rightAlignedComponents.size(); i++) {
            final WeakReference<JComponent> buttonRef = rightAlignedComponents.get(i);
            final JComponent button = buttonRef.get();

            retVal.add(button, cc.xy(colIdx, 1));
            ++colIdx;
        }

        return retVal;
    }

    /* Helper methods */

    public static JComponent buildOkBar(JComponent okButton) {
        final ButtonBarBuilder builder = new ButtonBarBuilder();
        builder.addComponentRight(okButton);
        return builder.build();
    }

    public static JComponent buildOkCancelBar(JComponent okButton, JComponent cancelButton) {
        return buildOkCancelBar(okButton, cancelButton, new JComponent[0]);
    }

    public static JComponent buildOkCancelBar(JComponent okButton, JComponent cancelButton,
            JComponent... otherBtns) {
        final ButtonBarBuilder builder = new ButtonBarBuilder();

        if (OSInfo.isMacOs()) {
            builder.addComponentRight(cancelButton);
            builder.addComponentRight(okButton);
        } else {
            builder.addComponentRight(okButton);
            builder.addComponentRight(cancelButton);
        }

        for (JComponent btn : otherBtns) {
            builder.addComponentLeft(btn);
        }

        return builder.build();
    }

}