com.sshtools.appframework.api.ui.ToolsBuilder.java Source code

Introduction

Here is the source code for com.sshtools.appframework.api.ui.ToolsBuilder.java

Source

/**
 * Appframework
 * Copyright (C) 2003-2016 SSHTOOLS Limited
 *
 * 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 2
 * of the License, or (at your option) any later version.
 */
package com.sshtools.appframework.api.ui;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import javax.swing.Action;
import javax.swing.JComponent;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.sshtools.appframework.ui.ActionToggleButton;
import com.sshtools.appframework.ui.PreferencesStore;
import com.sshtools.appframework.ui.SshToolsApplication;
import com.sshtools.ui.swing.ActionButton;
import com.sshtools.ui.swing.AppAction;
import com.sshtools.ui.swing.ToolBarSeparator;

public class ToolsBuilder<T extends JComponent> {

    final static Log log = LogFactory.getLog(ToolsBuilder.class);

    private T container;
    private List<AppAction> actions;

    public ToolsBuilder(T container) {
        this(container, null);
    }

    public ToolsBuilder(T container, List<AppAction> actions) {
        this.container = container;
        this.actions = actions;
    }

    public void rebuildActionComponents() {
        log.debug("Rebuilding action components");

        // Determine which actions are available
        List<AppAction> enabledActions = new ArrayList<AppAction>();
        for (AppAction action : listActions()) {
            try {
                String n = (String) action.getValue(Action.NAME);
                if (isActionVisible(n)) {
                    enabledActions.add(action);
                }
            } catch (NullPointerException npe) {
            }
        }
        log.debug("There are " + enabledActions.size() + " actions enabled");

        rebuildForActions(enabledActions);

        // Done
        resetActionState();
        log.debug("Rebuilt action components");
    }

    protected void rebuildForActions(List<AppAction> enabledActions) {
        // Rebuild components
        if (container != null) {
            rebuildContainer(enabledActions);
        }
    }

    protected void rebuildContainer(Collection<AppAction> enabledActions) {

        container.invalidate();
        container.removeAll();

        boolean useSmallIcons = PreferencesStore.getBoolean(SshToolsApplication.PREF_TOOLBAR_SMALL_ICONS, false);
        boolean showSelectiveText = PreferencesStore
                .getBoolean(SshToolsApplication.PREF_TOOLBAR_SHOW_SELECTIVE_TEXT, true);

        // Build the tool bar action list, grouping the actions
        List<AppAction> toolBarActions = new ArrayList<AppAction>();
        for (AppAction action : enabledActions) {
            if (Boolean.TRUE.equals(action.getValue(AppAction.ON_TOOLBAR))) {
                toolBarActions.add(action);
            }
        }
        log.debug("There are " + toolBarActions.size() + " in the toolbar");
        Collections.sort(toolBarActions, new ToolBarActionComparator());

        // Build the tool bar
        Integer grp = null;
        for (AppAction z : toolBarActions) {
            boolean grow = Boolean.TRUE.equals(z.getValue(AppAction.GROW));
            String constraints = grow ? "grow" : null;
            if ((grp != null) && !grp.equals(z.getValue(AppAction.TOOLBAR_GROUP))) {
                container.add(new ToolBarSeparator(), null);
            }
            if (z.getValue(AppAction.COMPONENT) != null) {
                JComponent jc = (JComponent) z.getValue(AppAction.COMPONENT);
                container.add(jc, constraints);
            } else if (Boolean.TRUE.equals(z.getValue(AppAction.IS_TOGGLE_BUTTON))) {
                ActionToggleButton tBtn = new ActionToggleButton(z, !useSmallIcons, showSelectiveText);
                container.add(tBtn, constraints);
            } else {
                ActionButton btn = new ActionButton(z,
                        !useSmallIcons ? AppAction.MEDIUM_ICON : AppAction.SMALL_ICON, showSelectiveText);
                container.add(btn, constraints);
            }
            grp = (Integer) z.getValue(AppAction.TOOLBAR_GROUP);
        }
        container.validate();
        container.repaint();
        if (container.getParent() != null) {
            container.getParent().validate();
        }
    }

    public void resetActionState() {

    }

    public boolean isActionVisible(String name) {
        return true;
    }

    public Collection<AppAction> listActions() {
        return actions;
    }

    protected T getContainer() {
        return container;
    }

    class ToolBarActionComparator implements Comparator<AppAction> {
        public int compare(AppAction o1, AppAction o2) {
            int i = ((Integer) o1.getValue(AppAction.TOOLBAR_GROUP))
                    .compareTo((Integer) o2.getValue(AppAction.TOOLBAR_GROUP));
            return (i == 0) ? ((Integer) o1.getValue(AppAction.TOOLBAR_WEIGHT))
                    .compareTo((Integer) o2.getValue(AppAction.TOOLBAR_WEIGHT)) : i;
        }
    }
}