Step 8 Parameters - Learn JBStrap

Setting the application parameters

In the ApplicationStartup class, look for the parameterSettings() method and change it so that it contains the following code:

        /**
 * Set JBStrap framework parameter
 */
@Override
public void parameterSettings(final ServletContext context) {
		// Set DataDescriptor directory
		JBStrap.setParam(JBStrapParamType.DATADESCRIPTOR_DIR, context.getRealPath("/WEB-INF/datadescriptors") );

		// Set persistence unit name
		JBStrap.setParam(JBStrapParamType.PERSISTENCE_UNIT_NAME, "ApplicationPU");

		// Set application entry point page (This is the application welcome page)
		JBStrap.setParam(JBStrapParamType.ENTRY_POINT, ApplicationConstants.ORDERS_PAGE);
		// Set application title
		JBStrap.setParam(JBStrapParamType.APPLICATION_TITLE, MessageSourceAPI.getMessage("application.name"));
		// Set application icon
		JBStrap.setParam(JBStrapParamType.APPLICATION_ICON, "/img/favicon.png");
		// Set application default language
		JBStrap.setParam(JBStrapParamType.DEFAULT_LANGUAGE, "EN");
	}
       

The method already contains the majority of the settings, but there are some that you need to configure manually. These settings include:

Setting the application’s starting page. Do this by setting the ENTRY_POINT parameter. Specify the ID of the page you want to set as the starting page. In this example, we want to display the orders page as the starting page, so specify ApplicationConstants.ORDERS_PAGE.
Next, we have to specify the application’s title. Use the APPLICATION_TITLE parameter to do this. Specify the text here that you want to display in the browser’s address bar.

Now we are ready with the parameters, but we still have to create the pages in the application.

Creating pages

Pages are created by using the createPages() method in the ApplicationStartup class. Modify the method, so the contents are the following:

        /**
 * Create application pages
 */
@Override
public void createPages() {
		// Register orders page to the application
		JBStrap.addPage(ApplicationConstants.ORDERS_PAGE, StandardUI.class, OrdersPage.class);
		// Register new older page to the application
		JBStrap.addPage(ApplicationConstants.NEW_ORDER_PAGE, StandardUI.class, NewOrderPage.class);
		// Register product search page to the application
		JBStrap.addPage(ApplicationConstants.SEARCH_PRODUCT, StandardUI.class, ProductSearchPage.class);
	}
       

Since there are three pages in the application, we have to write three lines. All lines are the same, only their parameters are different.

Register the pages in the JBStrap framework by using the JBStrap.addPage() method. The first parameter of the method is the unique ID of the page that you can use later to reference the page. The second parameter is the UI class used to display the page. In this example, there is one UI only, so you have to specify this UI. The last parameter is the page class to be registered in the framework. Specify the previously created classes.

The pages are now registered, you only have to create the menu.

Creating menus

Use the createMenus method to create menus. Later on, you can use this menu to build a NavBar component or a MenuBar component. The NavBar is the vertical navigation bar on the left side of the screen. The MenuBar is the horizontal menu on the top of the screen. In the current example, we use the menu to build the NavBar component.

        /**
 * Create application main menu and main menu items
 */
@Override
public void createMenus() {
		// Create main menu
		JBStrap.createMenu("mainMenu");

		// Add 3 menu item to the main manu, and define the navigation to the menu items
		JBStrap.addMenuItem("mainMenu", "orders", Icon.PACKAGE, MessageSourceAPI.getMessage("menu.orders"), MenuOperation.OPEN_PAGE, ApplicationConstants.ORDERS_PAGE);
		JBStrap.addMenuItem("mainMenu", "newOrder", Icon.PLUS, MessageSourceAPI.getMessage("menu.newOrder"), MenuOperation.OPEN_PAGE, ApplicationConstants.NEW_ORDER_PAGE);
		JBStrap.addMenuItem("mainMenu", "searchProduct", Icon.SEARCH, MessageSourceAPI.getMessage("menu.products"), MenuOperation.OPEN_PAGE, ApplicationConstants.SEARCH_PRODUCT);
	}
       

First, create the menu and name it. In the JBStrap framework, there can be multiple menus and you have to use their names to reference them. Use the JBStrap.createMenu("mainMenu”) method to create the mainMenu.

Add individual menu items to this menu. Do this by calling the JBStrap.addMenuItem() method. The method’s first parameter is the menu name. The second parameter is the menu item name. The parameter accepts any text value. The third parameter is the menu item icon. Note that both the NavBar and the MenuBar components can only display an icon on the top level. If you put the menu item to a lower level, this setting will be ignored.

The next parameter is the menu item text. Users will know what the menu item stands for. In our example, we retrieve this text from the strings.properties file.

Now you have to specify what should happen when users click on the menu item. Here you can choose from among one of the values of the MenuOperation enum. It can either be OPEN_PAGE or CUSTOM. If you specify CUSTOM , the custom implementation is executed when clicking on the menu item. If you choose OPEN_PAGE , you have to provide the page’s unique ID in the next parameter. The framework automatically opens it when clicking on the menu item. We use the OPEN_PAGE , because we want the page to open when users click on a menu item.

In the last parameter, specify the unique ID of the page.

The application is now ready. Compile and deploy it, and it is ready to use.