|  | Home · Overviews · Examples

# Order Form Example

The Order Form example shows how to generate rich text documents by combining a simple template with data input by the user in a dialog. Data is extracted from a `DetailsDialog` object and displayed on a `QTextEdit` with a `QTextCursor`, using various formats. Each form generated is added to a `QTabWidget` for easy access.

## DetailsDialog Class

            private static class DetailsDialog extends QDialog
            {
                private QLabel nameLabel;
                private QLabel addressLabel;
                private QCheckBox offersCheckBox;
                private QLineEdit nameEdit;
                private List<String> items;
                private QTableWidget itemsTable;
                private QTextEdit addressEdit;
                private QDialogButtonBox buttonBox;

The `DetailsDialog` class is a subclass of `QDialog`, implementing a slot `verify()` to allow contents of the `DetailsDialog` to be verified later.

The class defines three input widgets for the required fields, `nameEdit` and `addressEdit`. Also, a `QCheckBox` and a `QDialogButtonBox` are defined; the former to provide the user with the option to receive information on products and offers, and the latter to ensure that buttons used are arranged according to the user's native platform. In addition, a `QTableWidget`, `itemsTable`, is used to hold order details.

The screenshot below shows the `DetailsDialog` we intend to create.

The constructor of `DetailsDialog` accepts parameters title and parent. The class defines four getter functions: `orderItems()`, `senderName()`, `senderAddress()`, and `sendOffers()` to allow data to be accessed externally.

The earlier defined fields and their labels are initialized. The label for `offersCheckBox` is set and the `setupItemsTable()` function is invoked to setup and populate `itemsTable`. The `QDialogButtonBox` object, `buttonBox`, is instantiated with OK and Cancel buttons. This `buttonBox`'s `accepted()` and `rejected()` signals are connected to the `verify()` and `reject()` slots in `DetailsDialog`.

                public DetailsDialog(String title, QWidget parent)
                {
                    nameLabel = new QLabel(tr("Name:"));
                    addressLabel = new QLabel(tr("Address:"));
                    addressLabel.setAlignment(Qt.AlignmentFlag.createQFlags
                                (Qt.AlignmentFlag.AlignLeft, Qt.AlignmentFlag.AlignTop));

                    nameEdit = new QLineEdit();
                    addressEdit = new QTextEdit();

                    offersCheckBox = new QCheckBox(tr("Send information about products and "
                                                      + "special offers"));

                    setupItemsTable();

                    buttonBox = new QDialogButtonBox(new QDialogButtonBox.StandardButtons(
                                                     QDialogButtonBox.StandardButton.Ok,
                                                     QDialogButtonBox.StandardButton.Cancel));

                    buttonBox.accepted.connect(this, "verify()");
                    buttonBox.rejected.connect(this, "reject()");

A `QGridLayout` is used to place all the objects on the `DetailsDialog`.

                    QGridLayout mainLayout = new QGridLayout();
                    mainLayout.addWidget(nameLabel, 0, 0);
                    mainLayout.addWidget(nameEdit, 0, 1);
                    mainLayout.addWidget(addressLabel, 1, 0);
                    mainLayout.addWidget(addressEdit, 1, 1);
                    mainLayout.addWidget(itemsTable, 0, 2, 2, 1);
                    mainLayout.addWidget(offersCheckBox, 2, 1, 1, 2);
                    mainLayout.addWidget(buttonBox, 3, 0, 1, 3);
                    setLayout(mainLayout);

                    setWindowTitle(title);
                }

                public void verify()
                {
                    if (!nameEdit.text().equals("") &&
                        !addressEdit.toPlainText().equals("")) {
                        accept();
                        return;
                    }

                    QMessageBox.StandardButton answer;
                    answer = QMessageBox.warning(this, tr("Incomplete Form"),
                        tr("The form does not contain all the necessary information.\n"
                           + "Do you want to discard it?"),
                        new QMessageBox.StandardButtons(QMessageBox.StandardButton.Yes,
                                                        QMessageBox.StandardButton.No));

                    if (answer.equals(QMessageBox.StandardButton.Yes))
                        reject();
                }

                public List<QPair<String, Integer>> orderItems()
                {
                    List<QPair<String, Integer>> orderList = new Vector<QPair<String, Integer>>();

                    for (int row = 0; row < items.size(); ++row) {
                        int quantity = Integer.parseInt(
                            (String) itemsTable.item(row, 1).data(Qt.ItemDataRole.DisplayRole));

                        orderList.add(new QPair<String, Integer>(itemsTable.item(row, 0).text(),
                                      Math.max(0, quantity)));
                    }

                    return orderList;
                }

                public String senderName()
                {
                    return nameEdit.text();
                }

                public String senderAddress()
                {
                    return addressEdit.toPlainText();
                }

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `setupItemsTable()` function instantiates the `QTableWidget` object, `itemsTable`, and sets the number of rows based on the `List<String>` object, `items`, which holds the type of items ordered. The number of columns is set to 2, providing a "name" and "quantity" layout. A `for` loop is used to populate the `itemsTable` and the `name` item's flag is set to Qt::ItemIsEnabled or Qt::ItemIsSelectable. For demonstration purposes, the `quantity` item is set to a 1 and all items in the `itemsTable` have this value for quantity; but this can be modified by editing the contents of the cells at run time.

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `orderItems()` function extracts data from the `itemsTable` and returns it in the form of a `List<QPair<QString,Integer>>` where each QPair corresponds to an item and the quantity ordered.

                public List<QPair<String, Integer>> orderItems()
                {
                    List<QPair<String, Integer>> orderList = new Vector<QPair<String, Integer>>();

                    for (int row = 0; row < items.size(); ++row) {
                        int quantity = Integer.parseInt(
                            (String) itemsTable.item(row, 1).data(Qt.ItemDataRole.DisplayRole));

                        orderList.add(new QPair<String, Integer>(itemsTable.item(row, 0).text(),
                                      Math.max(0, quantity)));
                    }

                    return orderList;
                }

                public String senderName()
                {
                    return nameEdit.text();
                }

                public String senderAddress()
                {
                    return addressEdit.toPlainText();
                }

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `senderName()` function is used to return the value of the `QLineEdit` used to store the name field for the order form.

                public String senderName()
                {
                    return nameEdit.text();
                }

                public String senderAddress()
                {
                    return addressEdit.toPlainText();
                }

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `senderAddress()` function is used to return the value of the `QTextEdit` containing the address for the order form.

                public String senderAddress()
                {
                    return addressEdit.toPlainText();
                }

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `sendOffers()` function is used to return a `true` or `false` value that is used to determine if the customer in the order form wishes to receive more information on the company's offers and promotions.

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

The `verify()` function is an additionally implemented slot used to verify the details entered by the user into the `DetailsDialog`. If the details entered are incomplete, a `QMessageBox` is displayed providing the user the option to discard the `DetailsDialog`. Otherwise, the details are accepted and the `accept()` function is invoked.

                public void verify()
                {
                    if (!nameEdit.text().equals("") &&
                        !addressEdit.toPlainText().equals("")) {
                        accept();
                        return;
                    }

                    QMessageBox.StandardButton answer;
                    answer = QMessageBox.warning(this, tr("Incomplete Form"),
                        tr("The form does not contain all the necessary information.\n"
                           + "Do you want to discard it?"),
                        new QMessageBox.StandardButtons(QMessageBox.StandardButton.Yes,
                                                        QMessageBox.StandardButton.No));

                    if (answer.equals(QMessageBox.StandardButton.Yes))
                        reject();
                }

                public List<QPair<String, Integer>> orderItems()
                {
                    List<QPair<String, Integer>> orderList = new Vector<QPair<String, Integer>>();

                    for (int row = 0; row < items.size(); ++row) {
                        int quantity = Integer.parseInt(
                            (String) itemsTable.item(row, 1).data(Qt.ItemDataRole.DisplayRole));

                        orderList.add(new QPair<String, Integer>(itemsTable.item(row, 0).text(),
                                      Math.max(0, quantity)));
                    }

                    return orderList;
                }

                public String senderName()
                {
                    return nameEdit.text();
                }

                public String senderAddress()
                {
                    return addressEdit.toPlainText();
                }

                public boolean sendOffers()
                {
                    return offersCheckBox.isChecked();
                }

                private void setupItemsTable()
                {
                    items = new Vector<String>();
                    items.add(tr("T-shirt"));
                    items.add(tr("Badge"));
                    items.add(tr("Reference book"));
                    items.add(tr("Coffee cup"));

                    itemsTable = new QTableWidget(items.size(), 2);

                    for (int row = 0; row < items.size(); ++row) {
                        QTableWidgetItem name = new QTableWidgetItem(items.get(row));
                        name.setFlags(new Qt.ItemFlags(Qt.ItemFlag.ItemIsEnabled, Qt.ItemFlag.ItemIsSelectable));
                        itemsTable.setItem(row, 0, name);
                        QTableWidgetItem quantity = new QTableWidgetItem("1");
                        itemsTable.setItem(row, 1, quantity);
                    }
                }
            }

## MainWindow Class

The `MainWindow` class is a subclass of `QMainWindow`, implementing two slots - `openDialog()` and `printFile()`. It also contains a private instance of `QTabWidget`, `letters`. We will now review the implementation of the class.

The `MainWindow` constructor sets up the `fileMenu` and the required actions, `newAction` and `printAction`. These actions' `triggered()` signals are connected to the additionally implemented openDialog() slot and the default close() slot. The `QTabWidget`, `letters`, is instantiated and set as the window's central widget.

            public OrderForm() {
                QMenu fileMenu = new QMenu(tr("&File"), this);
                QAction newAction = fileMenu.addAction(tr("&New..."));
                newAction.setShortcut(tr("Ctrl+N"));
                printAction = new QAction(tr("&Print..."), this);
                fileMenu.addAction(printAction);
                printAction.setShortcut(tr("Ctrl+P"));
                printAction.setEnabled(false);
                QAction quitAction = fileMenu.addAction(tr("E&xit"));
                quitAction.setShortcut(tr("Ctrl+Q"));
                menuBar().addMenu(fileMenu);

                letters = new QTabWidget();

                newAction.triggered.connect(this, "openDialog()");
                printAction.triggered.connect(this, "printFile()");
                quitAction.triggered.connect(this, "close()");

                setCentralWidget(letters);
                setWindowTitle(tr("Order Form"));

                createSample();
            }

The `createLetter()` function creates a new `QTabWidget` with a `QTextEdit`, `editor`, as the parent. This function accepts four parameters that correspond to we obtained through `DetailsDialog`, in order to "fill" the `editor`.

            private void createLetter(String name, String address,
                                      List<QPair<String, Integer>> orderItems,
                                      boolean sendOffers) {
                QTextEdit editor = new QTextEdit();
                int tabIndex = letters.addTab(editor, name);
                letters.setCurrentIndex(tabIndex);

We then obtain the cursor for the `editor` using QTextEdit::textCursor(). The `cursor` is then moved to the start of the document using QTextCursor::Start.

                QTextCursor cursor = new QTextCursor(editor.textCursor());
                cursor.movePosition(QTextCursor.MoveOperation.Start);

Recall the structure of a Rich Text Document, where sequences of frames and tables are always separated by text blocks, some of which may contain no information.

In the case of the Order Form Example, the document structure for this portion is described by the table below:

frame with referenceFrameFormat
block | `A company`
block
block | `321 City Street`
block
block | `Industry Park`
block
block | `Another country`

This is accomplished with the following code:

                QTextFrame topFrame = cursor.currentFrame();
                QTextFrameFormat topFrameFormat = topFrame.frameFormat();
                topFrameFormat.setPadding(16);
                topFrame.setFrameFormat(topFrameFormat);

                QTextCharFormat textFormat = new QTextCharFormat();
                QTextCharFormat boldFormat = new QTextCharFormat();
                boldFormat.setFontWeight(QFont.Weight.Bold.value());

                QTextFrameFormat referenceFrameFormat = new QTextFrameFormat();
                referenceFrameFormat.setBorder(1);
                referenceFrameFormat.setPadding(8);
                referenceFrameFormat.setPosition(QTextFrameFormat.Position.FloatRight);
                referenceFrameFormat.setWidth(new QTextLength(QTextLength.Type.PercentageLength, 40));
                cursor.insertFrame(referenceFrameFormat);

                cursor.insertText("A company", boldFormat);
                cursor.insertBlock();
                cursor.insertText("321 City Street");
                cursor.insertBlock();
                cursor.insertText("Industry Park");
                cursor.insertBlock();
                cursor.insertText("Another country");

Note that `topFrame` is the `editor`'s top-level frame and is not shown in the document structure.

We then set the `cursor`'s position back to its last position in `topFrame` and fill in the customer's name (provided by the constructor) and address - using a `foreach` loop to traverse the `QString`, `address`.

                cursor.setPosition(topFrame.lastPosition());

                cursor.insertText(name, textFormat);

                for (String line : address.split("\n")) {
                    cursor.insertBlock();
                    cursor.insertText(line);
                }

The `cursor` is now back in `topFrame` and the document structure for the above portion of code is:

block | `Donald`
block | `47338 Park Avenue`
block | `Big City`

For spacing purposes, we invoke insertBlock() twice. The currentDate() is obtained and displayed. We use setWidth() to increase the width of `bodyFrameFormat` and we insert a new frame with that width.

                cursor.insertBlock();
                cursor.insertBlock();

                QDate date = QDate.currentDate();
                cursor.insertText(tr("Date: ") + date.toString("d MMMM yyyy"),
                        textFormat);
                cursor.insertBlock();

                QTextFrameFormat bodyFrameFormat = new QTextFrameFormat();
                bodyFrameFormat.setWidth(new QTextLength(QTextLength.Type.PercentageLength, 100));
                cursor.insertFrame(bodyFrameFormat);

The following code inserts standard text into the order form.

                cursor.insertText(tr("I would like to place an order for the following "
                        + "items:"), textFormat);
                cursor.insertBlock();
                cursor.insertBlock();

This part of the document structure now contains the date, a frame with `bodyFrameFormat`, as well as the standard text.

block
block
block | `Date: 25 May 2007`
block
frame with bodyFrameFormat
block | `I would like to place an order for the following items:`
block
block

A `QTextTableFormat` object, `orderTableFormat`, is used to hold the type of item and the quantity ordered.

                QTextTableFormat orderTableFormat = new QTextTableFormat();
                orderTableFormat.setAlignment(Qt.AlignmentFlag.AlignHCenter);
                QTextTable orderTable = cursor.insertTable(1, 2, orderTableFormat);

                QTextFrameFormat orderFrameFormat = cursor.currentFrame().frameFormat();
                orderFrameFormat.setBorder(1);
                cursor.currentFrame().setFrameFormat(orderFrameFormat);

We use cellAt() to set the headers for the `orderTable`.

                cursor = orderTable.cellAt(0, 0).firstCursorPosition();
                cursor.insertText(tr("Product"), boldFormat);

Then, we iterate through the List of QPair objects to populate `orderTable`.

                for (int i = 0; i < orderItems.size(); ++i) {
                    QPair<String, Integer> item = orderItems.get(i);
                    int row = orderTable.rows();

                    orderTable.insertRows(row, 1);
                    cursor = orderTable.cellAt(row, 0).firstCursorPosition();
                    cursor.insertText(item.first, textFormat);
                    cursor = orderTable.cellAt(row, 1).firstCursorPosition();
                    cursor.insertText("" + item.second, textFormat);
                }

The resulting document structure for this section is:

`orderTable` with orderTableFormat
block | `Product`
block | `Quantity`
block | `T-shirt`
block | `4`
block | `Badge`
block | `3`
block | `Reference book`
block | `2`
block | `Coffee cup`
block | `5`

The `cursor` is then moved back to `topFrame`'s lastPosition() and more standard text is inserted.

                cursor.setPosition(topFrame.lastPosition());

                cursor.insertBlock();
                cursor.insertText(tr("Please update my records to take account of the "
                        + "following privacy information:"));
                cursor.insertBlock();

Another `QTextTable` is inserted, to display the customer's preference regarding offers.

                QTextTable offersTable = cursor.insertTable(2, 2);

                cursor = offersTable.cellAt(0, 1).firstCursorPosition();
                cursor.insertText(tr("I want to receive more information about your "
                        + "company's products and special offers."), textFormat);
                cursor = offersTable.cellAt(1, 1).firstCursorPosition();
                cursor.insertText(tr("I do not want to receive any promotional information "
                        + "from your company."), textFormat);

                if (sendOffers)
                    cursor = offersTable.cellAt(0, 0).firstCursorPosition();
                else
                    cursor = offersTable.cellAt(1, 0).firstCursorPosition();

                cursor.insertText("X", boldFormat);

The document structure for this portion is:

block
block | `Please update my...`
block
`offersTable`
block | `I want to receive...`
block | `I do not want to recieve...`
block | `X`

The `cursor` is moved to insert "Sincerely" along with the customer's name. More blocks are inserted for spacing purposes. The `printAction` is enabled to indicate that an order form can now be printed.

                cursor.setPosition(topFrame.lastPosition());
                cursor.insertBlock();
                cursor.insertText(tr("Sincerely,"), textFormat);
                cursor.insertBlock();
                cursor.insertBlock();
                cursor.insertBlock();
                cursor.insertText(name);

                printAction.setEnabled(true);
            }

The bottom portion of the document structure is:

block
block | `Sincerely,`
block
block
block
block | `Donald`

The `createSample()` function is used for illustration purposes, to create a sample order form.

            public void createSample()
            {
                DetailsDialog dialog =
                    new DetailsDialog("Dialog with default values", this);
                createLetter("Mr. Smith", "12 High Street\nSmall Town\nThis country",
                             dialog.orderItems(), true);
            }

The `openDialog()` function opens a `DetailsDialog` object. If the details in `dialog` are accepted, the `createLetter()` function is invoked using the parameters extracted from `dialog`.

            public void openDialog() {
                DetailsDialog dialog =
                        new DetailsDialog(tr("Enter Customer Details"), this);

                if (dialog.exec() == QDialog.DialogCode.Accepted.value())
                    createLetter(dialog.senderName(), dialog.senderAddress(),
                            dialog.orderItems(), dialog.sendOffers());
            }

In order to print out the order form, a `printFile()` function is included, as shown below:

            public void printFile() {
                QTextEdit editor = (QTextEdit) letters.currentWidget();
                QPrinter printer = new QPrinter();

                QPrintDialog dialog = new QPrintDialog(printer, this);
                dialog.setWindowTitle(tr("Print Document"));
                if (editor.textCursor().hasSelection())
                    dialog.addEnabledOption(
                            QAbstractPrintDialog.PrintDialogOption.PrintSelection);

                if (dialog.exec() != QDialog.DialogCode.Accepted.value())
                    return;

                editor.print(printer);
            }

This function also allows the user to print a selected area with QTextCursor::hasSelection(), instead of printing the entire document.

## `main()` Function

The `main()` function instantiates `MainWindow` and sets its size to 640x480 pixels before invoking the `show()` function and `createSample()` function.

            public static void main(String args[])
            {
                QApplication.initialize(args);

                OrderForm window = new OrderForm();
                window.show();

                QApplication.exec();
            }