Step 6 Constants - Learn JBStrap

Application constants

This is the first group of constants mentioned above. In the present example, we will only record the IDs of the three pages we have created here, thus making our own business easier and avoiding typing or forgetting which card we gave which ID.

Implementation is extremely simple: We create a class into which we collect the constants used, in this case the ID of the sheets, as public string variables.

The ApplicationConstants.java source file already exists in the project that was generated from the archetype. Be sure to add the following lines:

public static final String ORDERS_PAGE = "orders";
public static final String NEW_ORDER_PAGE = "newOrder";
public static final String SEARCH_PRODUCT = "searchProduct";

After adding these lines, the ApplicationConstants source file should contain the following:

        package com.jbstrap.example;

/**
 * The application constants
 */
public class ApplicationConstants {

	/**
	 * The application name
	 */
	public static final String APPLICATION_NAME = "Application";

	/**
	 * The application version
	 */
	public static final String VERSION = "0.0.1-SNAPSHOT";

	/**
	 * Main page ID
	 */
	public static final String MAIN_PAGE = "mainPage";

	// The pageId of the application's pages
	public static final String ORDERS_PAGE = "orders";
	public static final String NEW_ORDER_PAGE = "newOrder";
	public static final String SEARCH_PRODUCT = "searchProduct";

}
       

Text constants

This group contains all the texts that are displayed on the interface: button labels, page headers, data labels, column names, etc. This example is not implemented in multiple languages, but the possibility is still there. Also, this guide tells you about how to do it.

Create a simple text file in the project’s resource folder and name it strings.properties .

This file lists all the strings to be used, identified by unique names. This should look like the following:

        # General strings
application.name=Order Manager
 
# Datasource titles
customer.id=ID
customer.firstName=First name
customer.lastName=Last Name
customer.city=City
customer.country=Country
customer.phone=Phone number
 
orderItems.id=ID
orderItems.orderId=Order ID
orderItems.productId=Product ID
orderItems.unitPrice=Unit price
orderItems.quantity=Quantity
orderItems.product.productName=Product
orderItems.amount=Amount
 
product.productName=Product name
product.supplierId=Supplier
product.supplier.contactName=Contact name
product.supplier.companyName=Supplier company name
product.supplier.country=Supplier country
product.supplier.city=Supplier city
product.unitPrice=Unit price
product.packing=Package
product.discontinued=Discontinued
 
supplier.id=ID
supplier.companyName=Company name
supplier.contactName=Contact name
supplier.contactTitle=Contact title
supplier.city=City
supplier.country=Country
supplier.phone=Phone number
supplier.fax=Fax number
 
 
#Order page
orders.title=Orders
orders.itemsTitle=Items in the selected order
orders.editor.title=Edit orders details
orders.editor.edit=Modify order
orders.editor.save=Save
orders.editor.close=Close
orders.editor.errorTitle=Error
orders.editor.errorText=The specified order information is invalid. Please fill all required field, and try again!

#Data columns
orders.id=ID
orders.orderDate=Order date
orders.orderNumber=Order number
orders.customer.firstName=First name
orders.customer.lastName=Last name
orders.customerId=Customer
orders.status=Status
orders.totalAmount=Total amount

#Product Search page
productSearch.title=Search in products

#New order
newOrder.title=Create new order
newOrder.save=Save
newOrder.cancel=cancel
newOrder.addItem=Add new item
newOrder.removeItem=Remove selected item
newOrder.addItemWindow.title=Add new item to the order
newOrder.addItemWindow.select=Select item
newOrder.addItemWindow.cancel=Cancel
newOrder.addItemWindow.quantity=Quantity
newOrder.addItemWindow.notItem.title=No produt selected
newOrder.addItemWindow.notItem.detail=Please select a product before adding it to your order and try again!
newOrder.removeItemConfirm.title=Are you sure?
newOrder.removeItemConfirm.message=Are you sure you want to delete {0} from your order?
newOrder.invalidForm.title=Error
newOrder.invalidForm.text=The specified order information is invalid. Please fill all required field, and try again!
newOrder.noProduct.title=Error
newOrder.noProduct.text=No product has been added to the order, so the order cannot be saved. Add at least one product to your order and try again!

#Menu
menu.orders=Orders
menu.newOrder=New order
menu.products=Search product
       

That file is created as strings.properties and contains default texts. If you want the application to be in another language (for example, German), all we have to do create a copy of this file as strings_de.properties and translate the texts into German. If you do this, the application is automatically displayed with German texts, provided that the user’s browser language setting is German. Use the # character to place notes in the file. In this project, notes are used to group the individual values. Note that the file also contains a Datasource titles part. This part contains labels/column headers associated with the data sources. Of course, if you don't want to implement it this way, you still can specify tags in the data source by using the title tag. Yet, it's better to do it this way, as this makes it easy to keep tags in one place, and this solution also supports multilingual implementation.

The texts mentioned here are easy to reference in the source code by using the MessageSourceAPI.