MenuBar.java

/*******************************************************************************
 *   Copyright (c) 2013 Steve Flasby
 *   All rights reserved.
 *   Redistribution and use in source and binary forms, with or without modification,
 *   are permitted provided that the following conditions are met:
 *   <ul>
 *       <li>Redistributions of source code must retain the above copyright notice,
 *           this list of conditions and the following disclaimer.</li>
 *       <li>Redistributions in binary form must reproduce the above copyright notice,
 *           this list of conditions and the following disclaimer in the documentation
 *           and/or other materials provided with the distribution.</li>
 *   </ul>
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *   IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *   OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 *   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  
 *******************************************************************************/
package org.flasby.swing;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JCheckBoxMenuItem;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;

import org.flasby.bus.Subject;
import org.flasby.bus.Subject.Delivery;
import org.flasby.util.Message;

public class MenuBar {

	public static abstract class Action<T> {
		public abstract void action( T item, ActionEvent e );
	}
	
	public static class Menu {
		private final String label;
		private final JMenu menu;
		private final Message msg;
		
		public Menu(JMenuBar parent, Message msg,  String id) {
			this.label = id;
			this.msg = msg;
			menu = new JMenu(msg.getMLS("menu."+id));
			parent.add(menu);
		}
		public Menu add(String id, final Action<JMenuItem> action) {
			final JMenuItem menuItem = new JMenuItem(msg.getMLS("menu."+label+"."+id) );
			if ( action!=null ) {
				menuItem.addActionListener( new ActionListener() {
					@Override
					public void actionPerformed(ActionEvent e) {
						action.action(menuItem, e);
					}
				});
			}
			menu.add(menuItem);
			return this;
		}
		public Menu add(String id, final Subject<Boolean> subject) {
			final JMenuItem menuItem = new JMenuItem(msg.getMLS("menu."+label+"."+id) );
			menuItem.addActionListener( new ActionListener() {
				@Override
				public void actionPerformed(ActionEvent e) {
					subject.send(true);
				}
			});
			menu.add(menuItem);
			menu.add(menuItem);
			return this;
		}
		public JCheckBoxMenuItem addCheckbox(String id, final Action<JCheckBoxMenuItem> action ) {
			final JCheckBoxMenuItem menuItem = new JCheckBoxMenuItem(msg.getMLS("menu."+label+"."+id) );
			if ( action!=null ) {
				menuItem.addActionListener( new ActionListener() {
					@Override
					public void actionPerformed(ActionEvent e) {
						action.action(menuItem, e);
					}
				});
			}
			menu.add(menuItem);
			return menuItem;
		}
		
		/**
		 * adds a checkbox item to the menubar.
		 * This is a live object, it publishes it's state changes over the Pagebus using the Subject.
		 * It also reacts to publications made to the Subject and changes it's state accordingly.
		 * @param id
		 * @param subject
		 * @return
		 */
		public Menu addCheckbox(String id, final Subject<Boolean> subject ) {
			final JCheckBoxMenuItem menuItem = new JCheckBoxMenuItem(msg.getMLS("menu."+label+"."+id) );
			menuItem.addActionListener( new ActionListener() {
				@Override
				public void actionPerformed(ActionEvent e) {
					subject.send(menuItem.isSelected());
				}
			});
			menu.add(menuItem);
			subject.subscribe(new Delivery<Boolean>() {
				@Override
				public void deliver(Boolean delivery) {
					menuItem.setSelected(delivery);
				}
			});
			return this;
		}
	}

	public static Menu create(JMenuBar parent, Message msg, String menuKey ) {
		return new Menu(parent, msg, menuKey);
	}
}