Trace:
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
visionx:documentation [2018/04/17 07:02] robot |
visionx:documentation [2018/06/10 21:05] admin |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ~~Title: VisionX Documentation~~ | ~~Title: VisionX Documentation~~ | ||
| - | Version: 5.0 / 2018-04-17 | + | Version: 5.0 / 2018-05-22 |
| ====== Introduction ====== | ====== Introduction ====== | ||
| - | VisionX is a tool for the efficient development of web-, mobile- and desktop applications. It focuses on database driven applications for businesses that facilitate data management and support processes. The resulting applications are based on open source frameworks such as JVx, Vaadin, Apache POI, iText and others. | + | VisionX is an [[https://visionx.sibvisions.com/low-code-platform/|open source low-code tool]] for the efficient development of web-, mobile- and desktop applications. It focuses on database driven applications for businesses that facilitate data management and support processes. The resulting applications are based on open source frameworks such as JVx, Vaadin, Apache POI, iText and others. |
| VisionX covers the entire application development process, which includes the data model design, the user interfaces, the business logic, the creation of reports, the import and export of data (EXCEL, CSV, XML), the access via web services and much more. | VisionX covers the entire application development process, which includes the data model design, the user interfaces, the business logic, the creation of reports, the import and export of data (EXCEL, CSV, XML), the access via web services and much more. | ||
| Line 263: | Line 263: | ||
| The following table shows all GUI elements and their properties that require explanation. In addition, all GUI element properties can be edit via Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the JVx Open Source framework on the internet. | The following table shows all GUI elements and their properties that require explanation. In addition, all GUI element properties can be edit via Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the JVx Open Source framework on the internet. | ||
| - | ^GUI Element ^Description ^ | + | ^GUI Element ^Description ^ |
| - | |Label |Label for input fields, etc. | | + | |Label |Label for input fields, etc. | |
| - | |Picture |Pictures can be added to the application using the picture library. A selection of images is included in VisionX. | | + | |Picture |Pictures can be added to the application using the picture library. A selection of images is included in VisionX. | |
| - | |Button\\ Toggle Button |Buttons usually trigger certain actions and can be used to display images and text. A Toggle Button is a button with two states (clicked, not clicked). | | + | |Button\\ Toggle Button |Buttons usually trigger certain actions and can be used to display images and text. A Toggle Button is a button with two states (clicked, not clicked). | |
| - | |Radio Button\\ Check Box |Option button and check box for the selection of one or more values. | | + | |Radio Button\\ Check Box |Option button and check box for the selection of one or more values. | |
| - | |Option Chooser |This element is a panel containing radio buttons. This GUI element has to be associated with a combo box table column. A radio button is created on the panel for each possible value on the drop-down list. Only one value can be selected. This element allows for the effortless creation of data-related radio groups. | | + | |Option Chooser |This element is a panel containing radio buttons. This GUI element has to be associated with a combo box table column. A radio button is created on the panel for each possible value on the drop-down list. Only one value can be selected. This element allows for the effortless creation of data-related radio groups. | |
| - | |Field Validator |Field validators are status fields that show whether the field validation for an associated table column was successful or not (green checkmark or red "X").\\ \\ This GUI element has to be associated with a table column; the validation related to the column has to be created using the action editor.\\ \\ The "Automatic validation" option immediately performs the validation VisionX Documentation 23 when the field is exited (this is the default setting). Otherwise the validation has to be initiated using the "Are Validations Ok" condition in an action (e.g. upon click of a "Save" button on the form).\\ \\ When the "Hide until first validate" option is selected, the validation field's status is not displayed until the validation has been performed. Otherwise it is displayed at all times. | | + | |Field Validator |Field validators are status fields that show whether the field validation for an associated table column was successful or not (green checkmark or red "X").\\ \\ This GUI element has to be associated with a table column; the validation related to the column has to be created using the action editor.\\ \\ The "Automatic validation" option immediately performs the validation VisionX Documentation 23 when the field is exited (this is the default setting). Otherwise the validation has to be initiated using the "Are Validations Ok" condition in an action (e.g. upon click of a "Save" button on the form).\\ \\ When the "Hide until first validate" option is selected, the validation field's status is not displayed until the validation has been performed. Otherwise it is displayed at all times. | |
| - | |Validation Result |This element displays validation errors that resulted from failed field validations. The associated GUI element determines which field validations are considered. All field validations on the same Panel/Split or tab are considered. | | + | |Validation Result |This element displays validation errors that resulted from failed field validations. The associated GUI element determines which field validations are considered. All field validations on the same Panel/Split or tab are considered. | |
| - | |Panel |A panel can contain other GUI elements or sub elements. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | | + | |Panel |A panel can contain other GUI elements or sub elements. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | |
| - | |Group Panel |A group panel can contain other elements as sub elements. In addition, this element has a frame and a title. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | | + | |Group Panel |A group panel can contain other elements as sub elements. In addition, this element has a frame and a title. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | |
| - | |Horizontal Split\\ Vertical Split |A split can contain exactly two elements as sub elements. The sub elements are separated horizontally or vertically by a moveable bar. | | + | |Horizontal Split\\ Vertical Split |A split can contain exactly two elements as sub elements. The sub elements are separated horizontally or vertically by a moveable bar. | |
| - | |Tabset |A tab set can contain other elements as sub elements. Each sub element is displayed as a tab with a label. | | + | |Tabset |A tab set can contain other elements as sub elements. Each sub element is displayed as a tab with a label. | |
| - | |Tree |One or more tables are displayed as trees. The used columns can be choosen. | | + | |Tree |One or more tables are displayed as trees. The used columns can be choosen. | |
| - | |Table |View A database table is displayed as a table including navigation containing New/Edit/Delete/CSV Export options.\\ \\ The column order, labels, and visible columns can be specified. An alternate column order and visibility can be specified for the display on mobile devices.\\ \\ In addition, the default sort setting can be determined via click (and Ctrl Shift + click) on the column headers. | | + | |Table |View A database table is displayed as a table including navigation containing New/Edit/Delete/CSV Export options.\\ \\ The column order, labels, and visible columns can be specified. An alternate column order and visibility can be specified for the display on mobile devices.\\ \\ In addition, the default sort setting can be determined via click (and Ctrl Shift + click) on the column headers. | |
| - | |Input Field\\ Dropdown List\\ Editor |A data-related table column is displayed as input field or drop-down list. | | + | |Input Field\\ Dropdown List\\ Editor |A data-related table column is displayed as input field or drop-down list. | |
| - | |Search\\ (Filter Editor) |Search boxes can limit the number of results in a table. Either all columns or a selected number of columns can be restricted using the selected search criteria. e.g.: full text search, smaller/greater/similar/... e.g. search for project number, name, ... | | + | |Search\\ (Filter Editor) |Search boxes can limit the number of results in a table. Either all columns or a selected number of columns can be restricted using the selected search criteria. e.g.: full text search, smaller/greater/similar/... e.g. search for project number, name, ... | |
| ===== Menu Management ===== | ===== Menu Management ===== | ||
| Line 488: | Line 488: | ||
| The following table summarizes all events that can be defined in VisionX. The availability of these depends on the GUI element to which they are applied. Furthermore, additional events can be defined using Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the Open Source Framework JVx on the internet. | The following table summarizes all events that can be defined in VisionX. The availability of these depends on the GUI element to which they are applied. Furthermore, additional events can be defined using Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the Open Source Framework JVx on the internet. | ||
| - | ^Event ^Description ^ | + | ^Event ^Description ^ |
| |On Load |This event occurs when a workscreen is opened. It it used to configure the data and elements that are to be displayed.\\ For example, user or role dependent views can be defined here.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | |On Load |This event occurs when a workscreen is opened. It it used to configure the data and elements that are to be displayed.\\ For example, user or role dependent views can be defined here.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | ||
| - | |On Show |This event occurs immediately after a workscreen is opened. It is used to configure the data and elements that are to be displayed.\\ At the time of the event, the workscreen is visible.\\ GUI Elements: Workscreen | | + | |On Show |This event occurs immediately after a workscreen is opened. It is used to configure the data and elements that are to be displayed.\\ At the time of the event, the workscreen is visible.\\ GUI Elements: Workscreen | |
| |On Activate |This event occurs each the a workscreen is activated using the "Open Screen" action, irrespective of whether the workscreen is opened or a previously opened workscreen is brought back to the foreground.\\ It can be used, for example, to evaluate parameters transferred from the called workscreen and to display the resulting values.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | |On Activate |This event occurs each the a workscreen is activated using the "Open Screen" action, irrespective of whether the workscreen is opened or a previously opened workscreen is brought back to the foreground.\\ It can be used, for example, to evaluate parameters transferred from the called workscreen and to display the resulting values.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | ||
| - | |On Close |This event occurs before a workscreen is closed. It is used to save data or to prevent closing the workscreen.\\ \\ GUI Elements: Workscreen | | + | |On Close |This event occurs before a workscreen is closed. It is used to save data or to prevent closing the workscreen.\\ \\ GUI Elements: Workscreen | |
| - | |Tab Activated |This event occurs when a tab is activated. It can be used to perform calculations or validations.\\ \\ GUI Elements: Workscreen | | + | |Tab Activated |This event occurs when a tab is activated. It can be used to perform calculations or validations.\\ \\ GUI Elements: Workscreen | |
| |Action |This event occurs at the click of a button.\\ It is used to start processes, execute logic, manipulate data, display reports or import data.\\ \\ GUI Elements: Button, Toggle Button, Radio Button Check Box | | |Action |This event occurs at the click of a button.\\ It is used to start processes, execute logic, manipulate data, display reports or import data.\\ \\ GUI Elements: Button, Toggle Button, Radio Button Check Box | | ||
| - | |Row Value Changed |This event occurs upon the change of a value in a row. There is only one value change event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ The condition "Is Column Changed" is used to determine which value has changed.\\ This event can be used to calculated dependent values.\\ \\ GUI Elements: Table, Editor | | + | |Row Value Changed |This event occurs upon the change of a value in a row. There is only one value change event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ The condition "Is Column Changed" is used to determine which value has changed.\\ This event can be used to calculated dependent values.\\ \\ GUI Elements: Table, Editor | |
| - | |After Row Selected |This event occurs after a row is selected in a table. There is only one "After Row Selected" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used to show/hide components, calculate values, or activate/deactivate buttons dependent on the data in the selected row.\\ GUI Elements: Table, Editor | | + | |After Row Selected |This event occurs after a row is selected in a table. There is only one "After Row Selected" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used to show/hide components, calculate values, or activate/deactivate buttons dependent on the data in the selected row.\\ GUI Elements: Table, Editor | |
| - | |After Inserting Row |This event occurs after a row is inserted in a table. There is only one "After Inserting Row" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used, for example, to fill a newly inserted row with standard values. | | + | |After Inserting Row |This event occurs after a row is inserted in a table. There is only one "After Inserting Row" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used, for example, to fill a newly inserted row with standard values. | |
| ====== Application - Live Preview ====== | ====== Application - Live Preview ====== | ||