001: /*
002:
003: ============================================================================
004: The Apache Software License, Version 1.1
005: ============================================================================
006:
007: Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
008:
009: Redistribution and use in source and binary forms, with or without modifica-
010: tion, are permitted provided that the following conditions are met:
011:
012: 1. Redistributions of source code must retain the above copyright notice,
013: this list of conditions and the following disclaimer.
014:
015: 2. Redistributions in binary form must reproduce the above copyright notice,
016: this list of conditions and the following disclaimer in the documentation
017: and/or other materials provided with the distribution.
018:
019: 3. The end-user documentation included with the redistribution, if any, must
020: include the following acknowledgment: "This product includes software
021: developed by the Apache Software Foundation (http://www.apache.org/)."
022: Alternately, this acknowledgment may appear in the software itself, if
023: and wherever such third-party acknowledgments normally appear.
024:
025: 4. The names "Batik" and "Apache Software Foundation" must not be
026: used to endorse or promote products derived from this software without
027: prior written permission. For written permission, please contact
028: apache@apache.org.
029:
030: 5. Products derived from this software may not be called "Apache", nor may
031: "Apache" appear in their name, without prior written permission of the
032: Apache Software Foundation.
033:
034: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
035: INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
036: FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
037: APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
038: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
039: DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
040: OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
041: ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
042: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
043: THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
044:
045: This software consists of voluntary contributions made by many individuals
046: on behalf of the Apache Software Foundation. For more information on the
047: Apache Software Foundation, please see <http://www.apache.org/>.
048:
049: */
050:
051: package org.apache.batik.util.gui.resource;
052:
053: import java.awt.Color;
054: import java.util.Iterator;
055: import java.util.List;
056: import java.util.MissingResourceException;
057: import java.util.ResourceBundle;
058:
059: import javax.swing.AbstractButton;
060: import javax.swing.ButtonGroup;
061: import javax.swing.JButton;
062: import javax.swing.JToolBar;
063: import javax.swing.plaf.basic.BasicBorders;
064:
065: import com.projity.help.HelpUtil;
066: import com.projity.menu.ExtButtonFactory;
067:
068: /**
069: * This class represents a tool bar factory which builds tool bars from the
070: * content of a resource file. <br>
071: *
072: * The resource entries format is (for a tool bar named 'ToolBar'): <br>
073: *
074: * <pre>
075: *
076: * ToolBar = Item1 Item2 - Item3 ...
077: * See ButtonFactory.java for details about the items
078: * ...
079: * '-' represents a separator
080: *
081: * </pre>
082: *
083: * All entries are optional.
084: *
085: * @author <a href="mailto:stephane@hillion.org">Stephane Hillion </a>
086: * @version $Id: ToolBarFactory.java,v 1.2 2007/09/19 03:17:43 nekosej Exp $
087: */
088: public class ToolBarFactory extends ResourceManager {
089: // Constants
090: //
091: private final static String SEPARATOR = "-";
092:
093: /**
094: * The table which contains the actions
095: */
096: private ActionMap actions;
097:
098: /**
099: * The button factory
100: */
101: private ButtonFactory buttonFactory;
102: /**
103: * The current radio group
104: */
105: private ButtonGroup buttonGroup;
106:
107: /**
108: * Creates a new tool bar factory
109: *
110: * @param rb
111: * the resource bundle that contains the menu bar description.
112: * @param am
113: * the actions to add to menu items
114: */
115: public ToolBarFactory(ResourceBundle rb, ActionMap am) {
116: super (rb);
117: actions = am;
118: buttonFactory = new ExtButtonFactory(rb, am);
119: buttonGroup = null;
120: }
121:
122: /**
123: * Creates a tool bar
124: *
125: * @param name
126: * the name of the menu bar in the resource bundle
127: * @throws MissingResourceException
128: * if one of the keys that compose the tool bar is missing. It
129: * is not thrown if the action key is missing.
130: * @throws ResourceFormatException
131: * if a boolean is malformed
132: * @throws MissingListenerException
133: * if an item action is not found in the action map.
134: */
135: public JToolBar createJToolBar(String name)
136: throws MissingResourceException, ResourceFormatException,
137: MissingListenerException {
138: JToolBar result = new JToolBar();
139: List buttons = getStringList(name);
140: Iterator it = buttons.iterator();
141:
142: while (it.hasNext()) {
143: String s = (String) it.next();
144: if (s.equals(SEPARATOR)) {
145: buttonGroup = null;
146: result.add(new JToolbarSeparator());
147: } else {
148: AbstractButton button = createJButton(s);
149: boolean visible = true;
150: try {
151: visible = getBoolean(s
152: + ExtButtonFactory.VISIBLE_SUFFIX);
153: } catch (MissingResourceException e) {
154: }
155: if (visible)
156: result.add(button);
157: }
158: }
159: return result;
160: }
161:
162: /**
163: * Creates and returns a new swing button
164: *
165: * @param name
166: * the name of the button in the resource bundle
167: * @throws MissingResourceException
168: * if key is not the name of a button. It is not thrown if the
169: * mnemonic and the action keys are missing
170: * @throws ResourceFormatException
171: * if the mnemonic is not a single character
172: * @throws MissingListenerException
173: * if the button action is not found in the action map.
174: */
175: public AbstractButton createJButton(String name)
176: throws MissingResourceException, ResourceFormatException,
177: MissingListenerException {
178: AbstractButton result = buttonFactory
179: .createJToolbarButton(name);
180: String type = null;
181: try {
182: type = getString(name + ExtButtonFactory.TYPE_SUFFIX);
183: } catch (MissingResourceException e) {
184: }
185: if (type != null) {
186: if (type.equals("RADIO")) {
187: if (buttonGroup == null)
188: buttonGroup = new ButtonGroup();
189: buttonGroup.add(result);
190: } else if (type.equals("TOGGLE")) {
191: result
192: .setBorder(new BasicBorders.ToggleButtonBorder(
193: Color.GRAY, Color.BLACK, Color.BLUE,
194: Color.CYAN));
195: result.setBorderPainted(true);
196: }
197: } else {
198:
199: buttonGroup = null;
200: }
201:
202: String help = getStringOrNull(name
203: + ExtButtonFactory.DOC_SUFFIX);
204: if (help != null)
205: HelpUtil.addDocHelp(result, help);
206: return result;
207: }
208:
209: /**
210: * Returns the boolean mapped with the given key
211: * @param key a key of the resource bundle
212: * @throws MissingResourceException if key is not the name of a resource
213: * @throws ResourceFormatException if the resource is malformed
214: */
215: public boolean getBoolean(String key)
216: throws MissingResourceException, ResourceFormatException {
217: String b = getString(key);
218:
219: if (b.equals("true")) {
220: return true;
221: } else if (b.equals("false")) {
222: return false;
223: } else {
224: throw new ResourceFormatException("Malformed boolean",
225: bundle.getClass().getName(), key);
226: }
227: }
228: }
|