Class DefaultFormBuilder

java.lang.Object
com.jgoodies.forms.internal.AbstractBuilder<PanelBuilder>
com.jgoodies.forms.internal.AbstractFormBuilder<PanelBuilder>
com.jgoodies.forms.builder.PanelBuilder
com.jgoodies.forms.builder.I15dPanelBuilder
com.jgoodies.forms.builder.DefaultFormBuilder
@Deprecated public final class DefaultFormBuilder extends I15dPanelBuilder
Deprecated.
Replaced by the FormBuilder and the internationalization support provided by the JGoodies Smart Client Resources class. Although deprecated, this class will remain in the Forms library for the next versions.
Provides a means to build form-oriented panels quickly and consistently using the FormLayout. This builder combines frequently used panel building steps: add a new row, add a label, proceed to the next data column, then add a component.

The extra value lies in the #append methods that append gap rows and component rows if necessary and then add the given components. They are built upon the superclass behavior #appendRow and the set of #add methods. A set of component appenders allows to add a textual label and associated component in a single step.

This builder can map resource keys to internationalized (i15d) texts when creating text labels, titles and titled separators. Therefore you must specify a ResourceBundle in the constructor. The builder methods throw an IllegalStateException if one of the mapping builder methods is invoked and no bundle has been set.

You can configure the build process by setting a leading column, enabling the row grouping and by modifying the gaps between normal lines and between paragraphs. The leading column will be honored if the cursor proceeds to the next row. All appended components start in the specified lead column, except appended separators that span all columns.

It is temptive to use the DefaultFormBuilder all the time and to let it add rows automatically. Use a simpler style if it increases the code readability. Explicit row specifications and cell constraints make your layout easier to understand - but harder to maintain. See also the accompanying tutorial sources and the Tips & Tricks that are part of the Forms documentation.

Sometimes a form consists of many standardized rows but has a few rows that require a customization. The DefaultFormBuilder can do everything that the superclasses AbstractFormBuilder and PanelBuilder can do; among other things: appending new rows and moving the cursor. Again, ask yourself if the DefaultFormBuilder is the appropriate builder. As a rule of thumb you should have more components than builder commands. There are different ways to add custom rows. Find below example code that presents and compares the pros and cons of three approaches.

The texts for labels and titles can be marked texts, i.e. strings with an optional mnemonic marker. See the MnemonicUtils class comment for details.

Example: 

public void build() {
    FormLayout layout = new FormLayout(
        "right:max(40dlu;pref), 3dlu, 80dlu, 7dlu, " // 1st major colum
      + "right:max(40dlu;pref), 3dlu, 80dlu",        // 2nd major column
        "");                                         // add rows dynamically
    DefaultFormBuilder builder = new DefaultFormBuilder(layout)
                .border(Borders.DIALOG);

    builder.appendSeparator("Flange");

    builder.append("Identifier", identifierField);
    builder.nextLine();

    builder.append("PTI [kW]",   new JTextField());
    builder.append("Power [kW]", new JTextField());

    builder.append("s [mm]",     new JTextField());
    builder.nextLine();

    builder.appendSeparator("Diameters");

    builder.append("da [mm]",    new JTextField());
    builder.append("di [mm]",    new JTextField());

    builder.append("da2 [mm]",   new JTextField());
    builder.append("di2 [mm]",   new JTextField());

    builder.append("R [mm]",     new JTextField());
    builder.append("D [mm]",     new JTextField());

    builder.appendSeparator("Criteria");

    builder.append("Location",   buildLocationComboBox());
    builder.append("k-factor",   new JTextField());

    builder.appendSeparator("Bolts");

    builder.append("Material",   ViewerUIFactory.buildMaterialComboBox());
    builder.nextLine();

    builder.append("Numbers",    new JTextField());
    builder.nextLine();

    builder.append("ds [mm]",    new JTextField());
}

Custom Row Example: 

public JComponent buildPanel() {
    initComponents();

    FormLayout layout = new FormLayout(
            "right:pref, 3dlu, default:grow",
            "");
    DefaultFormBuilder builder = new DefaultFormBuilder(layout)
            .border(Borders.DIALOG)
         .rowGroupingEnabled(true);

    // In this approach, we add a gap and a custom row.
    // The advantage of this approach is, that we can express
    // the row spec and comment area cell constraints freely.
    // The disadvantage is the misalignment of the leading label.
    // Also the row's height may be inconsistent with other rows.
    builder.appendSeparator("Single Custom Row");
    builder.append("Name", name1Field);
    builder.appendLineGapRow();
    builder.appendRow(RowSpec.decode("top:31dlu")); // Assumes line is 14, gap is 3
    builder.nextLine(2);
    builder.append("Comment");
    builder.add(new JScrollPane(comment1Area),
                CC.xy(builder.getColumn(), builder.getRow(), "fill, fill"));
    builder.nextLine();

    // In this approach, we append a standard row with gap before it.
    // The advantage is, that the leading label is aligned well.
    // The disadvantage is that the comment area now spans
    // multiple cells and is slightly less flexible.
    // Also the row's height may be inconsistent with other rows.
    builder.appendSeparator("Standard + Custom Row");
    builder.append("Name", name2Field);
    builder.append("Comment");
    builder.appendRow(RowSpec.decode("17dlu")); // Assumes line is 14, gap is 3
    builder.add(new JScrollPane(comment2Area),
                CC.xywh(builder.getColumn(), builder.getRow(), 1, 2));
    builder.nextLine(2);

    // In this approach, we append two standard rows with associated gaps.
    // The advantage is, that the leading label is aligned well,
    // and the height is consistent with other rows.
    // The disadvantage is that the comment area now spans
    // multiple cells and is slightly less flexible.
    builder.appendSeparator("Two Standard Rows");
    builder.append("Name", name3Field);
    builder.append("Comment");
    builder.nextLine();
    builder.append("");
    builder.nextRow(-2);
    builder.add(new JScrollPane(comment3Area),
                CC.xywh(builder.getColumn(), builder.getRow(), 1, 3));

    return builder.build();
}

TODO: Consider adding a method for appending a component that spans the remaining columns in the current row. Method name candidates are #appendFullSpan and #appendRemaining.

Since:
1.0.3
Version:
$Revision: 1.16 $
See Also:

  • Field Details

    • defaultRowSpec

      private RowSpec defaultRowSpec
      Deprecated.
      Holds the row specification that is reused to describe rows that are intended for labels and components.
      See Also:
      • invalid reference 
        #setDefaultRowSpec(RowSpec)

    • lineGapSpec

      private RowSpec lineGapSpec
      Deprecated.
      Holds the row specification that is reused to describe the constant gaps between component lines.
      See Also:
      • invalid reference 
        #setLineGapSize(ConstantSize)

    • paragraphGapSpec

      private RowSpec paragraphGapSpec
      Deprecated.
      Holds the row specification that describes the constant gaps between paragraphs.
      See Also:
      • invalid reference 
        #setParagraphGapSize(ConstantSize)

    • leadingColumnOffset

      private int leadingColumnOffset
      Deprecated.
      Holds the offset of the leading column - often 0 or 1.
      See Also:
      • invalid reference 
        #getLeadingColumnOffset()
      • invalid reference 
        #setLeadingColumnOffset(int)
      • getLeadingColumn()

    • rowGroupingEnabled

      private boolean rowGroupingEnabled
      Deprecated.
      Determines whether new data rows are being grouped or not.
      See Also:
      • invalid reference 
        #isRowGroupingEnabled()
      • invalid reference 
        #setRowGroupingEnabled(boolean)

  • Constructor Details

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout.
      Parameters:
      layout - the FormLayout to be used
      Throws:
      NullPointerException - if layout is null

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout, JPanel container)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout and panel.
      Parameters:
      layout - the FormLayout to be used
      container - the layout container
      Throws:
      NullPointerException - if layout or container is null

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout, ResourceBundle bundle)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout and resource bundle.
      Parameters:
      layout - the FormLayout to be used
      bundle - the ResourceBundle used to lookup i15d strings
      Throws:
      NullPointerException - if layout is null

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout, ResourceBundle bundle, JPanel container)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout, resource bundle, and panel.
      Parameters:
      layout - the FormLayout to be used
      bundle - the ResourceBundle used to lookup i15d strings
      container - the layout container
      Throws:
      NullPointerException - if layout or container is null

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout, com.jgoodies.common.internal.StringResourceAccessor localizer)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout and resource bundle.
      Parameters:
      layout - the FormLayout to be used
      localizer - used to lookup i15d strings
      Throws:
      NullPointerException - if layout is null

    • DefaultFormBuilder

      public DefaultFormBuilder(FormLayout layout, com.jgoodies.common.internal.StringResourceAccessor localizer, JPanel container)
      Deprecated.
      Constructs a DefaultFormBuilder for the given layout, resource bundle, and panel.
      Parameters:
      layout - the FormLayout to be used
      localizer - used to lookup i15d strings
      container - the layout container
      Throws:
      NullPointerException - if layout or container is null

  • Method Details

    • background

      public DefaultFormBuilder background(Color background)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets the panel's background color and makes the panel opaque.
      Overrides:
      background in class I15dPanelBuilder
      Parameters:
      background - the color to set as new background
      See Also:

    • border

      public DefaultFormBuilder border(Border border)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets the panel's border.
      Overrides:
      border in class I15dPanelBuilder
      Parameters:
      border - the border to set
      See Also:

    • border

      public DefaultFormBuilder border(String emptyBorderSpec)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets the panel's border as an EmptyBorder using the given specification for the top, left, bottom, right in DLU. For example "1dlu, 2dlu, 3dlu, 4dlu" sets an empty border with 1dlu in the top, 2dlu in the left side, 3dlu at the bottom, and 4dlu in the right hand side.

      Equivalent to padding(Paddings.createPadding(paddingSpec)).

      Overrides:
      border in class I15dPanelBuilder
      Parameters:
      emptyBorderSpec - describes the top, left, bottom, right sizes of the EmptyBorder to create
      See Also:

    • padding

      public DefaultFormBuilder padding(EmptyBorder padding)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets a padding around this builder's panel.
      Overrides:
      padding in class I15dPanelBuilder
      Parameters:
      padding - the empty border to set
      See Also:

    • padding

      public DefaultFormBuilder padding(String paddingSpec, Object... args)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets the panel's padding as an EmptyBorder using the given specification for the top, left, bottom, right margins in DLU. For example "1dlu, 2dlu, 3dlu, 4dlu" sets an empty border with 1dlu in the top, 2dlu in the left side, 3dlu at the bottom, and 4dlu in the right hand side.

      Equivalent to setPadding(Paddings.createPadding(paddingSpec)).

      Overrides:
      padding in class I15dPanelBuilder
      Parameters:
      paddingSpec - describes the top, left, bottom, right margins of the padding (an EmptyBorder) to use
      args - optional format arguments, used if paddingSpec is a format string
      Returns:
      a reference to this builder
      See Also:

    • opaque

      public DefaultFormBuilder opaque(boolean b)
      Deprecated.
      Description copied from class: AbstractBuilder
      Sets the panel's opaque state.
      Overrides:
      opaque in class I15dPanelBuilder
      Parameters:
      b - true for opaque, false for non-opaque
      See Also:

    • defaultRowSpec

      public DefaultFormBuilder defaultRowSpec(RowSpec defaultRowSpec)
      Deprecated.
      Sets the row specification that shall be used for component rows. It is FormSpecs.PREF_ROWSPEC by default.
      Parameters:
      defaultRowSpec - the RowSpec to be used for component rows

    • lineGapSize

      public DefaultFormBuilder lineGapSize(ConstantSize lineGapSize)
      Deprecated.
      Sets the size of gaps between component lines using the given constant size.

      Examples:

      .lineGapSize(Sizes.ZERO);
.lineGapSize(Sizes.DLUY9);
.lineGapSize(Sizes.pixel(1));
      Parameters:
      lineGapSize - the ConstantSize that describes the size of the gaps between component lines

    • paragraphGapSize

      public DefaultFormBuilder paragraphGapSize(ConstantSize paragraphGapSize)
      Deprecated.
      Sets the size of gaps between paragraphs using the given constant size.

      Examples:

      .setParagraphGapSize(Sizes.DLUY14);
.setParagraphGapSize(Sizes.dluY(22));
.setParagraphGapSize(Sizes.pixel(42));
      Parameters:
      paragraphGapSize - the ConstantSize that describes the size of the gaps between paragraphs

    • leadingColumnOffset

      public DefaultFormBuilder leadingColumnOffset(int columnOffset)
      Deprecated.
      Sets the offset of the leading column, often 0 or 1.
      Parameters:
      columnOffset - the new offset of the leading column

    • rowGroupingEnabled

      public DefaultFormBuilder rowGroupingEnabled(boolean enabled)
      Deprecated.
      Enables or disables the grouping of new data rows.
      Parameters:
      enabled - indicates grouping enabled, false disabled

    • appendLineGapRow

      public final void appendLineGapRow()
      Deprecated.
      Appends a row with this builder's line gap size.
      See Also:

    • append

      public void append(Component component)
      Deprecated.
      Adds a component to the panel using the default constraints with a column span of 1. Then proceeds to the next data column.
      Parameters:
      component - the component to add

    • append

      public void append(Component component, int columnSpan)
      Deprecated.
      Adds a component to the panel using the default constraints with the given columnSpan. Proceeds to the next data column.
      Parameters:
      component - the component to append
      columnSpan - the column span used to add

    • append

      public void append(Component c1, Component c2)
      Deprecated.
      Adds two components to the panel; each component will span a single data column. Proceeds to the next data column.
      Parameters:
      c1 - the first component to add
      c2 - the second component to add

    • append

      public void append(Component c1, Component c2, Component c3)
      Deprecated.
      Adds three components to the panel; each component will span a single data column. Proceeds to the next data column.
      Parameters:
      c1 - the first component to add
      c2 - the second component to add
      c3 - the third component to add

    • append

      public JLabel append(String textWithMnemonic)
      Deprecated.
      Adds a text label to the panel and proceeds to the next column.
      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      Returns:
      the added label

    • append

      public JLabel append(String textWithMnemonic, Component component)
      Deprecated.
      Adds a text label and component to the panel. Then proceeds to the next data column.

      The created label is labeling the given component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      component - the component to add
      Returns:
      the added label

    • append

      public JLabel append(String textWithMnemonic, Component c, boolean nextLine)
      Deprecated.
      Adds a text label and component to the panel; the component will span the specified number columns. Proceeds to the next data column, and goes to the next line if the boolean flag is set.

      The created label is labeling the given component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c - the component to add
      nextLine - true forces a next line
      Returns:
      the added label
      See Also:

    • append

      public JLabel append(String textWithMnemonic, Component c, int columnSpan)
      Deprecated.
      Adds a text label and component to the panel; the component will span the specified number columns. Proceeds to the next data column.

      The created label is labeling the given component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c - the component to add
      columnSpan - number of columns the component shall span
      Returns:
      the added label
      See Also:

    • append

      public JLabel append(String textWithMnemonic, Component c1, Component c2)
      Deprecated.
      Adds a text label and two components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c1 - the first component to add
      c2 - the second component to add
      Returns:
      the added label

    • append

      public JLabel append(String textWithMnemonic, Component c1, Component c2, int colSpan)
      Deprecated.
      Adds a text label and two components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c1 - the first component to add
      c2 - the second component to add
      colSpan - the column span for the second component
      Returns:
      the created label

    • append

      public JLabel append(String textWithMnemonic, Component c1, Component c2, Component c3)
      Deprecated.
      Adds a text label and three components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c1 - the first component to add
      c2 - the second component to add
      c3 - the third component to add
      Returns:
      the added label

    • append

      public JLabel append(String textWithMnemonic, Component c1, Component c2, Component c3, Component c4)
      Deprecated.
      Adds a text label and four components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      c1 - the first component to add
      c2 - the second component to add
      c3 - the third component to add
      c4 - the fourth component to add
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey)
      Deprecated.
      Adds an internationalized (i15d) text label to the panel using the given resource key and proceeds to the next column.
      Parameters:
      resourceKey - the resource key for the the label's text
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component component)
      Deprecated.
      Adds an internationalized (i15d) text label and component to the panel. Then proceeds to the next data column.

      The created label is labeling the given component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      component - the component to add
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component component, boolean nextLine)
      Deprecated.
      Adds an internationalized (i15d) text label and component to the panel. Then proceeds to the next data column. Goes to the next line if the boolean flag is set.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      component - the component to add
      nextLine - true forces a next line
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component c, int columnSpan)
      Deprecated.
      Adds an internationalized (i15d) text label to the panel using the given resource key; then proceeds to the next data column and adds a component with the given column span. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      c - the component to add
      columnSpan - number of columns the component shall span
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component c1, Component c2)
      Deprecated.
      Adds an internationalized (i15d) text label and two components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      c1 - the first component to add
      c2 - the second component to add
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component c1, Component c2, int colSpan)
      Deprecated.
      Adds an internationalized (i15d) text label and two components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      c1 - the first component to add
      c2 - the second component to add
      colSpan - the column span for the second component
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component c1, Component c2, Component c3)
      Deprecated.
      Adds an internationalized (i15d) text label and three components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      c1 - the first component to add
      c2 - the second component to add
      c3 - the third component to add
      Returns:
      the added label

    • appendI15d

      public JLabel appendI15d(String resourceKey, Component c1, Component c2, Component c3, Component c4)
      Deprecated.
      Adds an internationalized (i15d) text label and four components to the panel; each component will span a single column. Proceeds to the next data column.

      The created label is labeling the first component; so the component gets the focus if the (optional) label mnemonic is pressed.

      Parameters:
      resourceKey - the resource key for the text to add
      c1 - the first component to add
      c2 - the second component to add
      c3 - the third component to add
      c4 - the third component to add
      Returns:
      the added label

    • appendTitle

      public JLabel appendTitle(String textWithMnemonic)
      Deprecated.
      Adds a title label to the panel and proceeds to the next column.
      Parameters:
      textWithMnemonic - the label's text - may mark a mnemonic
      Returns:
      the added title label

    • appendI15dTitle

      public JLabel appendI15dTitle(String resourceKey)
      Deprecated.
      Adds an internationalized title label to the panel and proceeds to the next column.
      Parameters:
      resourceKey - the resource key for the title's text
      Returns:
      the added title label

    • appendSeparator

      public JComponent appendSeparator()
      Deprecated.
      Adds a separator without text that spans all columns.
      Returns:
      the added titled separator

    • appendSeparator

      public JComponent appendSeparator(String text)
      Deprecated.
      Adds a separator with the given text that spans all columns.
      Parameters:
      text - the separator title text
      Returns:
      the added titled separator

    • appendI15dSeparator

      public JComponent appendI15dSeparator(String resourceKey)
      Deprecated.
      Appends an internationalized titled separator for the given resource key that spans all columns.
      Parameters:
      resourceKey - the resource key for the separator title's text
      Returns:
      the added titled separator

    • getLeadingColumn

      protected int getLeadingColumn()
      Deprecated.
      Returns the leading column. Unlike the superclass this method honors the column offset.
      Overrides:
      getLeadingColumn in class AbstractFormBuilder<PanelBuilder>
      Returns:
      the leading column

    • ensureCursorColumnInGrid

      private void ensureCursorColumnInGrid()
      Deprecated.
      Ensures that the cursor is in the grid. In case it's beyond the form's right hand side, the cursor is moved to the leading column of the next line.

    • ensureHasGapRow

      private void ensureHasGapRow(RowSpec gapRowSpec)
      Deprecated.
      Ensures that we have a gap row before the next component row. Checks if the current row is the given RowSpec and appends this row spec if necessary.
      Parameters:
      gapRowSpec - the row specification to check for

    • ensureHasComponentLine

      private void ensureHasComponentLine()
      Deprecated.
      Ensures that the form has a component row. Adds a component row if the cursor is beyond the form's bottom.

    • getCursorRowSpec

      private RowSpec getCursorRowSpec()
      Deprecated.
      Looks up and returns the row specification of the current row.
      Returns:
      the row specification of the current row