IndependentModeler/src/cz/cvut/promod/services/componentFactoryService/ComponentFactoryService.java

   1 package cz.cvut.promod.services.componentFactoryService;
   2
   3 import com.jidesoft.swing.JideButton;
   4 import com.jidesoft.grid.PropertyTable;
   5 import com.jidesoft.status.StatusBar;
   6 import com.jidesoft.status.LabelStatusBarItem;
   7 import com.jidesoft.status.ButtonStatusBarItem;
   8 import com.jidesoft.pane.OutlookTabbedPane;
   9
  10 import javax.swing.*;
  11 import javax.swing.tree.TreeNode;
  12 import java.awt.*;
  13
  14 import cz.cvut.promod.services.Service;
  15
  16 /**
  17  * ProMod, master thesis project
  18  * User: Petr Zverina, petr.zverina@gmail.com
  19  * Date: 21:13:35, 5.1.2010
  20  */
  21
  22 /**
  23  * All Plugins and even the Modeler are supposed to use ComponentFactoryClass for creation of GUI components
  24  * (including Swing components and JideSoft components).
  25  *
  26  * This programming style should ensure some kind of visual consistency in ProMod application.
  27  */
  28 public interface ComponentFactoryService extends Service {
  29
  30     /**
  31      * Defines the recommended form border. Usually for usage in JGoodies.Borders factory.
  32      * @see com.jgoodies.forms.factories.Borders
  33      */
  34     public static final String DEFAULT_FORM_BORDER = "5dlu, 5dlu, 5dlu, 5dlu";
  35
  36
  37     /** Defines horizontal orientation of an instance of JideButton class */
  38     public static final int JIDE_BUTTON_HORIZONTAL_ORIENTATION = 0;
  39
  40     /** Defines vertical orientation of an instance of JideButton class */
  41     public static final int JIDE_BUTTON_VERTICAL_ORIENTATION = 1;
  42
  43     /**
  44      * @return an instance of JComboBox class
  45      */
  46     public JComboBox createComboBox();
  47
  48     /**
  49      * @return an instance of JSpinner class
  50      */
  51     public JSpinner createSpinner();
  52
  53     /**
  54      * @return an instance of JTextArea class
  55      */
  56     public JTextArea createTextArea();
  57
  58     /**
  59      * @return an instance of JTextField class
  60      */
  61     public JTextField createTextField();
  62
  63     /**
  64      * @param text to be displayed in the JTextField
  65      * @return an instance of JTextField class
  66      */
  67     public JTextField createTextField(final String text);
  68
  69
  70     /**
  71      * @return an instance of JSlider class
  72      */
  73     public JSlider createSlider();
  74
  75     /**
  76      * @param text is a text to be displayed on the Label
  77      * @return an instance of Label class
  78      */
  79     public JLabel createLabel(final String text);
  80
  81     /**
  82      * @return an instance of JTree class
  83      */
  84     public JTree createTree();
  85
  86     /**
  87      * @return an instance of JTree class
  88      */
  89     public JTree createTree(final TreeNode node);
  90
  91     /**
  92      * @param component is a component to be inserted to the ScrollPane
  93      * @return an instance of ScrollPane class
  94      */
  95     public JScrollPane createScrollPane(final Component component);
  96
  97     /**
  98      * @return an instance of JCheckBox class
  99      */
 100     public JCheckBox createCheckBox();
 101
 102     /**
 103      * @return an instance of MenuBar class
 104      */
 105     public JMenuBar createMenuBar();
 106
 107     /**
 108      * @return an instance of JToolBar class
 109      */
 110     public JToolBar createToolBar();
 111
 112     /**
 113      * @param text is a text to be displayed on the Menu
 114      * @return an instance of Menu class
 115      */
 116     public JMenu createMenu(final String text);
 117
 118     /**
 119      * @return an instance of JPopupMenu class
 120      */
 121     public JPopupMenu createPopupMenu();
 122
 123     /**
 124      * @return an instance of OutlookTabbedPane class.
 125      */
 126     public OutlookTabbedPane createOutlookTabbedPane();
 127
 128     /**
 129      * @param text is a text to be displayed on the MenuItem
 130      * @return an instance of MenuItem class
 131      */
 132     public JMenuItem createMenuItem(final String text);
 133
 134     /**
 135      * @param text is a text to be displayed on the Button
 136      * @param icon is a icon to be displayed on the Button
 137      * @return an instance of Button class
 138      */
 139     public JButton createButton(final String text, final Icon icon);
 140
 141     /**
 142      * @param text is a text to be displayed on the ToggleButton
 143      * @param icon is a icon to be displayed on the ToggleButton
 144      * @return an instance of ToggleButton class
 145      */
 146     public JToggleButton createToggleButton(final String text, final Icon icon);
 147
 148     /**
 149      *
 150      * @param text is a text to be displayed on the button
 151      * @param icon is an icon to be displayed on the button
 152      * @param orientation JIDE_BUTTON_HORIZONTAL_ORIENTATION or JIDE_BUTTON_VERTICAL_ORIENTATION
 153      * @return an instance of JideButton class
 154      */
 155     public JideButton createJideButton( final String text, final Icon icon, int orientation );
 156
 157     /**
 158      * @return an instance of JPanel class
 159      */
 160     public JPanel createPanel();
 161
 162     /**
 163      * @return an instance of JList class
 164      */
 165     public JList createList();
 166
 167     /**
 168      * @return an instance of JTable class
 169      */
 170     public JTable createTable();
 171
 172     /**
 173      * @return an instance of PropertyTable class
 174      */
 175     public PropertyTable createPropertyTable();
 176
 177     /**
 178      * @see com.jidesoft.status.StatusBar
 179      *
 180      * @return an instance of StatusBar class
 181      */
 182     public StatusBar createStatusBar();
 183
 184     /**
 185      * @see com.jidesoft.status.LabelStatusBarItem
 186      *
 187      * @return an instance of LabelStatusBarItem class
 188      */
 189     public LabelStatusBarItem createLabelStatusBarItem();
 190
 191     /**
 192      * @see com.jidesoft.status.ButtonStatusBarItem
 193      *
 194      * @return an instance of ButtonStatusBarItem class
 195      */
 196     public ButtonStatusBarItem createButtonStatusBarItem();
 197
 198      /**
 199      * @return an instance of JColorChooser class
 200      */
 201     public JColorChooser createColorChooser();
 202
 203      /**
 204      * @param text is the text for the button
 205      * @return an instance of JRadioButton class
 206      */
 207     public JRadioButton createRadioButton(final String  text);
 208
 209      /**
 210      * @return an instance of JTabbedPane class
 211      */
 212     public JTabbedPane createTabbedPane();
 213 }