Java tutorial
/* * Copyright (c) 2002-2014 JGoodies Software GmbH. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o 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. * * o Neither the name of JGoodies Software GmbH nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * 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 OWNER 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 com.jgoodies.forms.factories; import javax.swing.Action; import javax.swing.JButton; import javax.swing.JComponent; import javax.swing.JLabel; /** * An interface that defines the factory methods as used by the * {@link com.jgoodies.forms.builder.PanelBuilder} and its subclasses.<p> * * The String arguments passed to the methods {@code #createLabel(String)}, * {@code #createTitle(String)}, and * {@code #createSeparator(String, int)} can contain an optional * mnemonic marker. The mnemonic and mnemonic index are indicated * by a single ampersand (<tt>&</tt>). For example * <tt>"&Save"</tt>, or <tt>"Save &as"</tt>. * To use the ampersand itself duplicate it, for example * <tt>"Look&&Feel"</tt>. * * @author Karsten Lentzsch * @version $Revision: 1.10 $ * * @see DefaultComponentFactory * @see com.jgoodies.forms.builder.PanelBuilder */ public interface ComponentFactory { /** * Creates and returns a button that is bound to the given Action. * Useful to return customized buttons, for example, the JGoodies * {@code JGButton} is bound to some custom Action properties. * * @param action provides [bound] visual properties for the button * @return the created button * * @since 1.4 */ JButton createButton(Action action); /** * Creates and returns a label with an optional mnemonic.<p> * * <pre> * createLabel("Name"); // No mnemonic * createLabel("N&ame"); // Mnemonic is 'a' * createLabel("Save &as"); // Mnemonic is the second 'a' * createLabel("Look&&Feel"); // No mnemonic, text is Look&Feel * </pre> * * @param textWithMnemonic the label's text - * may contain an ampersand (<tt>&</tt>) to mark a mnemonic * @return an label with optional mnemonic */ JLabel createLabel(String textWithMnemonic); /** * Creates and returns a label with an optional mnemonic * that is intended to label a read-only component.<p> * * <pre> * createReadOnlyLabel("Name"); // No mnemonic * createReadOnlyLabel("N&ame"); // Mnemonic is 'a' * createReadOnlyLabel("Save &as"); // Mnemonic is the second 'a' * createReadOnlyLabel("Look&&Feel"); // No mnemonic, text is Look&Feel * </pre> * * @param textWithMnemonic the label's text - * may contain an ampersand (<tt>&</tt>) to mark a mnemonic * @return an label with optional mnemonic intended for read-only * components * * @since 1.3 */ JLabel createReadOnlyLabel(String textWithMnemonic); /** * Creates and returns a title label that uses the foreground color * and font of a {@code TitledBorder}.<p> * * <pre> * createTitle("Name"); // No mnemonic * createTitle("N&ame"); // Mnemonic is 'a' * createTitle("Save &as"); // Mnemonic is the second 'a' * createTitle("Look&&Feel"); // No mnemonic, text is Look&Feel * </pre> * * @param textWithMnemonic the label's text - * may contain an ampersand (<tt>&</tt>) to mark a mnemonic * @return an emphasized title label */ JLabel createTitle(String textWithMnemonic); /** * Creates and returns a label intended for pane headers that uses * a larger font than the control font and a special foreground color. * For example, on the Windows platform this method may use the font, * size, and color of the TaskDialog main instruction as described * by the MS User Experience Guide.<p> * * If the label text is marked with the mnemonic marker '&', * the mnemonic and mnemonic index will be configured. * For example if {@code markedText} is "&Charge Codes", the text * will be set to "Charge Codes", the mnemonic is 'C', and the * mnemonic index is 0.<p> * * A simple implementation may just delegate to * {@link #createTitle(String)}. * * @param markedText the label text with optional mnemonic marker * @return a label intended for pane headers * * @since 1.6 */ JLabel createHeaderLabel(String markedText); /** * Creates and returns a labeled separator. Useful to separate * paragraphs in a panel, which is often a better choice than a * {@code TitledBorder}.<p> * * <pre> * final int LEFT = SwingConstants.LEFT; * createSeparator("Name", LEFT); // No mnemonic * createSeparator("N&ame", LEFT); // Mnemonic is 'a' * createSeparator("Save &as", LEFT); // Mnemonic is the second 'a' * createSeparator("Look&&Feel", LEFT); // No mnemonic, text is Look&Feel * </pre> * * @param textWithMnemonic the label's text - * may contain an ampersand (<tt>&</tt>) to mark a mnemonic * @param alignment text alignment, one of {@code SwingConstants.LEFT}, * {@code SwingConstants.CENTER}, {@code SwingConstants.RIGHT} * @return a title label with separator on the side */ JComponent createSeparator(String textWithMnemonic, int alignment); }