com.viaoa.jfc.OAPopupTree Maven / Gradle / Ivy

Go to download
/*  Copyright 1999-2015 Vince Via [email protected]
    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 com.viaoa.jfc;

import java.awt.*;
import java.awt.event.*;
import java.lang.reflect.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.tree.*;
import com.viaoa.hub.*;
import com.viaoa.util.*;
import com.viaoa.jfc.control.*;
import com.viaoa.jfc.table.*;
import com.viaoa.jfc.tree.OATreeNodeData;


/**
    Popup OATree that is controlled by mouse click on another component.
    
    Example:

    OAPopupTree tree = new OAPopupTree();
    
    JButton cmd = new JButton("See Tree");
    dc.setButton(cmd);
    -- or --
    OACommand cmd = new OACommand(hubEmployee);
    dc.setButton(cmd);
    
    For more information about this package, see documentation.
    @see OAPopup
    @see OATree
*/
public class OAPopupTree extends OATree {

    protected OAPopup popup;
    protected boolean bHideOnSelect=true;
    private JComponent controller;  // component that triggers popup

    /**
        Create a new Popup Tree.
    */
    public OAPopupTree() {
    }
    
    /**
        Create a new Popup Tree.
    */
    public OAPopupTree(JComponent comp) {
        setController(comp);
    }

    // 2006/12/13
    protected OAPopup getPopup() {
    	Component comp = null;
    	if (popup == null) {
    		if (getAllowClearButton()) {
    			JPanel pan = new JPanel(new BorderLayout());
                pan.add(BorderLayout.NORTH, new JScrollPane(this));
                pan.add(getButtonCommands());
                comp = pan;
    		}
    		else {
    			comp = this;
    		}
    		popup = new OAPopup(new JScrollPane(comp));
            if (controller != null) popup.setupListener(controller);
    	}
    	return popup;
    }
    
    
    /**
        @deprecated does not support align anymore.
    */
    public OAPopupTree(JComponent comp, int align) {
        setController(comp);
    }


    /** 
        Component used to set the popup to be visible.
    */
    public void setController(JComponent comp) {
    	this.controller = comp;
    	popup = null;
    	getPopup();
    }

    /**
        Flag to have the popup displayed only when the right mouse button is clicked.
    */
    public void setRightClickOnly(boolean b) {
        getPopup().setRightClickOnly(b);
    }

    /** if true (default), popup is hidden when tree item is selected. */
    public void setHideOnSelect(boolean b) {
        bHideOnSelect = b;
    }
    public boolean getHideOnSelect() {
        return bHideOnSelect;
    }

    /** 
        Overwritten to hide the popup when a node is selected. 
    */
    public @Override void nodeSelected(TreeSelectionEvent e) {
        super.nodeSelected(e);
        if (bHideOnSelect) {
            TreePath tp = e.getNewLeadSelectionPath();
            if (tp != null) {
                Object[] objs = tp.getPath();
                OATreeNodeData tnd = (OATreeNodeData) objs[objs.length-1];
                if (!(tnd.node instanceof OATreeTitleNode)) {
                    if (tnd.node.hub != null || tnd.node.def.updateHub != null) {
                        if (popup != null) popup.setVisible(false);
                    }
                }
            }
        }
    }
    
    /*
     *  2006/12/14
     *  Can be overwritten to clear selected value.  Called when clicking the clear button
     *  on the bottom of the combo popup.
     */
    public void onClear() {
    	// this needs to be overwritten.
    }
    private boolean bAllowClear;
    public void allowClearButton(boolean b) {
    	if (b != bAllowClear) {
	    	popup = null;
	    	this.bAllowClear = b;
	    	getPopup();
    	}
    }
    public boolean getAllowClearButton() {
    	return bAllowClear;
    }
   
    private JPanel getButtonCommands() {
    	JPanel pan = new JPanel(new FlowLayout(FlowLayout.CENTER, 5, 0));
    	JButton cmd = new JButton("close");
    	cmd.addActionListener(new ActionListener() {
    		public void actionPerformed(ActionEvent e) {
                if (popup != null) popup.setVisible(false);
    		}
    	});
    	OACommand.setup(cmd);
    	pan.add(cmd);

    	if (getAllowClearButton()) {
	    	cmd = new JButton("clear");
	    	cmd.addActionListener(new ActionListener() {
	    		public void actionPerformed(ActionEvent e) {
	    			onClear();
                    if (popup != null) popup.setVisible(false);
	    		}
	    	});
	    	OACommand.setup(cmd);
	    	// cmd.setToolTipText("remove current selected value and close.");
	    	pan.add(cmd);
    	}
    	return pan;
    }
    

}