Differences

This shows you the differences between two versions of the page.

--- visionx:modern_web_application [2019/07/01 11:39]
robot
+++ visionx:modern_web_application [2021/11/18 11:29]
admin
@@ Line 1: / Line 1: @@
 ~~NOTRANS~~
+{{SIDETOC}}
 ~~Title: Modern web application~~
-Version: 5.0 / 2018-03-07
+Version: 5.1.2 / 2019-12-09
 ====== Introduction ======
-The objective of this tutorial is the creation of a modern web application with VisionX. It is assumed that a VisionX Project is already available.
+The objective of this tutorial is the creation of a modern web application with VisionX. It is assumed that a VisionX project is already available.
-====== Creating a Work Screen ======
+====== Creating a Workscreen ======
-First we need to create a WorkScreen in VisionX. Press the "New Screen" Button (1) fill in a Name and click "Next" (2).
+First, we need to create a workscreen in VisionX. Press the "New Screen" button (1) fill in a name and click "Next" (2).
 {{:visionx:modern_web_application:create-workscreen-step1.png?nolink|Creating a workscreen}}
-In the following wizard select "Empty application screen" and press "Finish" to create an empty Screen.
+In the following wizard, select "Empty application screen" and press "Finish" to create an empty screen.
 {{:visionx:modern_web_application:create-workscreen-step2.png?nolink|Selecting an empty layout}}
@@ Line 20: / Line 20: @@
 ====== Changing the Layout ======
-For our modern web application we use a so called "Editing Panel" to edit customer data.
+For our modern web application, we use a so-called "Editing Panel" to edit customer data.
-In the "Elements" area pick up an "Editing Panel" (1) and drag it (2) into the Center of our newly created Screen.
+In the "Elements" area, pick up an "Editing Panel" (1) and drag it (2) into the center of our newly created screen.
 {{:visionx:modern_web_application:add-morphpanel.png?nolink|Adding an Editing Panel}}
-For our next step we need a table to store our customer data in. For this purpose click the green plus in the bottom of your VisionX-Designer under the label "NEW Table" (1). For this tutorial let's assume we already have a customer table available in our database. In the "Datasource Wizard" we therefore select the "Use existing data from database tables" option (2). Press next (3) to continue.
+For our next step, we need a table to store our customer data in. For this purpose, click the green plus in the bottom of your VisionX designer under the label "NEW Table" (1). For this tutorial, let's assume we already have a customer table available in our database. If you don't have an existing customer table, simply create a new screen with demo customers from [[https://doc.sibvisions.com/_media/visionx/modern_web_application/customers.csv|this]] spreadsheet. In the Datasource Wizard, we, therefore, select the "Use existing data from database tables" option (2). Press next (3) to continue.
 {{:visionx:modern_web_application:create-table-step1.png?nolink|Creating a table from an existing table}}
-The customer table is available in the applications database so we select the "Use Application Database User" option for the connection.
+The customer table is available in the applications database, so we select the "Use Application Database User" option for the connection.
 {{:visionx:modern_web_application:create-table-step2.png?nolink|Use the applications database user}}
-In the third step we select the company table in the table dropdown and finish the creation of the table with "Finish".
+In the third step, we select the company table in the table dropdown and finish the creation of the table with "Finish".
 {{:visionx:modern_web_application:create-table-step3.png?nolink|Select the database table}}
-Having created the table we can now start with the layout of our screen. In this step we add the table (1) to our panel. Furthermore we are adding a search bar (2) and a button (3) to create a new customer.
+Having created the table, we can now start with the layout of our screen. In this step, we add the table (1) to our panel. Furthermore, we add a search bar (2) and an insert button from the "Web Elements" (3) to create a new customer.
 {{:visionx:modern_web_application:create-table-layout.png?nolink|Layouting our table}}
-This is how our Screen should look in the Designer by now:
+This is how our screen should look in the designer by now:
 {{:visionx:modern_web_application:create-table-layout-designer.png?nolink|The finished layout}}
-With this being done we can now look what our application looks like via the VisionX Live Preview:
+With this being done, we can now see what our application looks like via the VisionX Live Preview:
 {{:visionx:modern_web_application:create-table-layout-done.png?nolink|The finished layout}}
-After this our layout for the master screen is done.
+After this, our layout for the master screen is done.
-Now we can start creating the form to manage the customer data. For this we select the "Form" tab in our Editing Panel. Next we need to add a panel in the center of this tab. From the lower part of the Designer we can now select our unused editors (1) and drag them into our panel. After our editors are set in place we add some labels (2) and a panel with three buttons (3) on the bottom.
+Now we can start creating the form to manage the customer data. For this, we select the "Form" tab in our editing panel. Next, we need to add a panel in the center of this tab. From the lower part of the designer, we can now select our unused editors (1) and drag them into our panel. After our editors are set in place, we add some labels (2) and a panel with the three "Web Element" (3) buttons "Save", "Delete" and, "Cancel" on the bottom.
 {{:visionx:modern_web_application:create-form-layout.png?nolink|Starting on our form layout}}
-Once again this is how it should look in the Designer now:
+Once again, this is how it should look in the designer:
 {{:visionx:modern_web_application:create-form-layout-designer.png?nolink|The finished layout}}
-After having set everything in place this is how our form is looking in the Live Preview:
+After having set everything in place, this is how our form looks in the Live Preview:
 {{:visionx:modern_web_application:create-form-layout-done.png?nolink|Starting on our form layout}}
-To give our application a nice and modern look we are going to change the design in VisionX. For this we select the Dropdown next to "Settings" in the right VisionX Toolbar and press "Web" (1).
+To give our application a nice and modern look, we are going to change the design in VisionX. For this, we select the dropdown next to "Settings" in the right VisionX toolbar and press "Web" (1).
 {{:visionx:modern_web_application:open-web-settings.png?nolink|Opening the Web Settings}}
-In the following wizard change the "Display mode" to "Corporation" (1) and the "Theme" to "Valo" (2).
+In the following wizard, change the "Display mode" to "Corporation".
 {{:visionx:modern_web_application:set-web-design.png?nolink|Change Web Design}}
-This is how our Screen looks with the Valo-Theme now:
+This is how our screen looks with the corporation mode now:
 {{:visionx:modern_web_application:layout-valo.png?nolink|Change Web Design}}
-====== Adding some Functionality ======
+====== Adding Some Functionality ======
-Now that we have the layouts done we can start to implement some functionality for our application. To start this we are going to add an action to our "New" Button on the master screen. For this we select our button and click on the edit icon (1). As the next step we click "Create Action" (2) in the "Events" section of this menu.
+Now that we have the layouts done, we can start to implement some functionality for our application. Most of this is done implicitly by the "Web Elements" buttons we added.
-{{:visionx:modern_web_application:create-action-step1.png?nolink|Creating an action}}
+The "New" button adds a new Customer and selects the "Form" tab to edit it.
-In the following wizard we select the "Action" tab (1) and create both an "Insert row before" command (2) on our table and an "Select Tab" command (3) on the Editing Panel. With this a row is inserted and the form shown when we click this button.
+The "Save" button saves the currently selected Customer and selects the "Table" tab.
-{{:visionx:modern_web_application:create-action-insert.png?nolink|Building the insert action}}
+The "Delete" button deletes the currently selected Customer and selects the "Table" tab.
-To follow up on this we are going to add actions to the three buttons we created on our form. We are going to skip the things we already established and go straight to the actions this time.
+The "Cancel" button reverts the changes done to the currently selected Customer and selects the "Table" tab.
-Action for the Save-Button:
+As the next step, we have to remove the navigation of the editing panel and set the display mode to "Inline". This settings will change the layout of the panel from Tabset to Panel without Tabs. Every click in the table will show the Form. To do this, we have to select the editing panel and click on the edit icon (1). In the menu, we deselect "Show Navigation" (2) and change the "Display Mode" to "Inline" and "Navigation Mode" to "Single Click" (3).
-{{:visionx:modern_web_application:create-action-save.png?nolink|The save action}}
-Action for the Delete-Button:
-{{:visionx:modern_web_application:create-action-delete.png?nolink|The delete action}}
-Action for the Cancel-Button:
-{{:visionx:modern_web_application:create-action-cancel.png?nolink|The cancel action}}
-For one of our last steps done in the VisionX Designer we are going to remove the navigation of the Editing Panel. For this we have to select the Editing Panel and click on the edit icon (1). In the menu we deselect "Show Navigation" (2).
 {{:visionx:modern_web_application:remove-navigation.png?nolink|Removing the Editing Panel navigation}}
-====== Giving the application the last touch ======
+====== Giving the Application the Final Touch ======
-To give our modern web application the last touch we are going to have to make some changes in the source code itself. For this we are going to make use of JVx's FontAwesome support and add some nice icons to our buttons.
+To give our modern web application the final touch, we have to make some changes in the source code itself. For this, we are going to make the table readonly. Most web applications don't show the selected row in a table, so we are going to disable that as well.
 <code java>
-buttonNewCustomer.setImage(UIImage.getImage(IFontAwesome.PLUS_SMALL));
+//disable selection, set table readonly
-buttonSaveCustomer.setImage(UIImage.getImage(IFontAwesome.SAVE_SMALL));
-buttonDeleteCustomer.setImage(UIImage.getImage(IFontAwesome.ERASER_SMALL));
-buttonCancelCustomer.setImage(UIImage.getImage(IFontAwesome.CLOSE_SMALL));
-</code>
-Next up we are going to make our table readonly and add a mouse click listener which is going to open the form after selecting a company. Furthermore we are going to make the table deselected when the screen is opened so that the form is not shown immediately. Most web applications don't show the selected row in a table so we are going to disable that as well.
-<code java>
-//No selection initially
-rdbCustomer.setSelectionMode(SelectionMode.DESELECTED);
-//disable selection, set table readonly, add click listener
 tableCustomer.setShowSelection(false);
 tableCustomer.setEditable(false);
-tableCustomer.eventMouseClicked().addListener(this, "doTableClicked");
-//doTableClicked Function
-public void doTableClicked() throws Throwable
-{
-    morphPanelMain.setSelectedIndexIfExists(1);
-}
 </code>
-To export our table as a .csv File we are adding a menu next to the "New" Button on our master screen.
+We are also going to add a menu button next to the "New" button that lets us delete a row and export the table. For this, we grab the "Menu Button" from the "Web Elements" and position where we want it to be. Additionally, we are going to add some margins between the search bar and the buttons.
-<code java>
+To change up the design a bit, we are going to add edit the stylesheet of this application in order to style the title of our form. For this, we once again open the "Web"settings in VisionX like we did when changing the "Display mode" (Settings -> Web). In the following wizard, we select the "Style" tab and set the font-size to 20px and the font to "OpenSans".
-//The menu itself
-private UIMenu          menCustomers            = new UIMenu();
-//The underlying menu bar
-private UIMenuBar       mbarCustomers           = new UIMenuBar();
-//Menu item for our dropdown
-private UIMenuItem      miCustomersCSVExport    = new UIMenuItem();
-//Add the csv export action to this menu item
-miCustomersCSVExport.setText("CSV export");
-miCustomersCSVExport.eventAction().addListener(this, "doCustomerCsvExport");
-//Setup the menu
-menCustomers.setImage(UIImage.getImage(IFontAwesome.BARS_SMALL));
-menCustomers.add(miCustomersCSVExport);
-mbarCustomers.add(menCustomers);
-//This only works in a web environment
-if (getApplication().getLauncher().isWebEnvironment())
-{
-    //Without vlayout, the menubar won't be shown
-    VerticalLayout vlUserMenu = new VerticalLayout();
-    vlUserMenu.addComponent(((WrappedMenuBar)mbarCustomers.getResource()).getMenuBar());
-    //Create a custom component and add it to our panel
-    UICustomComponent compUserMenu = new UICustomComponent(vlUserMenu);
-    panelSearch.add(compUserMenu, formLayout1.getVCenterConstraints(-3, 0));
-}
-//The csv export
-public void doCustomerCsvExport() throws Throwable
-{
-    tableCustomer.doExport();
-}
-</code>
-To change up the design a bit we are going to add a stylesheet to this application in order to style the title of our form. For this we have to add the following configuration to our web.xml file which is located in the WebContent\WEB-INF in the root folder of our project.
-<code xml>
-<servlet>
-    <servlet-name>VaadinUI</servlet-name>
-    <servlet-class>com.sibvisions.rad.ui.vaadin.server.VaadinServlet</servlet-class>
-    <init-param>
-        <param-name>externalCss</param-name>
-        <param-value>../../company.css</param-value>
-    </init-param>
-    <!-- Some more initialization parameters -->
-<servlet>
-</code>
-Next we have to add the .css File to our WebContent folder. For this example we just set the font-size to 20px and the font to OpenSans
 <code css>
@@ Line 193: / Line 112: @@
 }
 </code>
-To set the style we have to edit the label (1) which is once again done by pressing the edit button. Set the style to "company-edit" (2) and we are done.
+{{:visionx:modern_web_application:change-stylesheet.png?nolink|Chainging the stylesheet}}
+To set the style, we have to edit the label (1), which is, once again, done by pressing the edit button. Set the style to "company-edit" (2), and we are done.
 {{:visionx:modern_web_application:set-style.png?nolink|Setting the style}}
-====== The finished application ======
+====== The Finished Application ======
-With this done this let's look how our application is looking in a web environment. For this we once again use the "Preview" Button in VisionX. This will start a browser window which shows our finished application:
+With this done, let's look at how our application is looking in a web environment. For this, we, once again, use the "Preview" button in VisionX. This will start a browser window that shows our finished application:
 {{:visionx:modern_web_application:master-screen.png?nolink|The master screen}}