Trace:
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
visionx:eplug_guide [2020/06/05 17:34] cduncan [Build options] |
visionx:eplug_guide [2024/11/25 15:10] (current) admin |
||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ====== Introduction ====== | ====== Introduction ====== | ||
| - | [[https://eplug.sibvisions.com/|EPlug]] is a plugin to extend the [[https://www.eclipse.org/|Eclipse Java Integrated Development Environment]] with support and additional features for development with the [[https://jvx.sibvisions.com/|JVx Application Framework]] and the [[https://visionx.sibvisions.com/|VisionX Rapid Application Development Tool]]. | + | EPlug is a plugin to extend the [[https://www.eclipse.org/|Eclipse Java Integrated Development Environment]] with support and additional features for development with the [[https://jvx.sibvisions.com/|JVx Application Framework]] and the [[https://visionx.sibvisions.com/|VisionX Rapid Application Development Tool]]. |
| Because [[https://jvx.sibvisions.com/|JVx]] is utilizing various different techniques to achieve its goals and the necessity to work around technical limitations, we provide support to IDEs like Eclipse to achieve a very good user experience when building complex applications. | Because [[https://jvx.sibvisions.com/|JVx]] is utilizing various different techniques to achieve its goals and the necessity to work around technical limitations, we provide support to IDEs like Eclipse to achieve a very good user experience when building complex applications. | ||
| Line 12: | Line 12: | ||
| ====== Features ====== | ====== Features ====== | ||
| - | [[https://eplug.sibvisions.com/|EPlug]] extends the Java IDE with additional features and functionality, for example: | + | EPlug extends the Java IDE with additional features and functionality, for example: |
| * Extended auto-completion | * Extended auto-completion | ||
| Line 27: | Line 27: | ||
| ====== Installation ====== | ====== Installation ====== | ||
| - | [[https://eplug.sibvisions.com/|EPlug]] can be installed from the [[https://marketplace.eclipse.org/|Eclipse Marketplace]] by using the [[http://marketplace.eclipse.org/content/eplug-visionx|EPlug marketplace entry]]. | + | EPlug can be installed from the [[https://marketplace.eclipse.org/|Eclipse Marketplace]] by using the [[http://marketplace.eclipse.org/content/eplug-visionx|EPlug marketplace entry]]. |
| {{:visionx:eplug_guide:eplug-visionx-marketplace-entry.png?nolink|The EPlug-VisionX marketplace page.}} | {{:visionx:eplug_guide:eplug-visionx-marketplace-entry.png?nolink|The EPlug-VisionX marketplace page.}} | ||
| Line 35: | Line 35: | ||
| ====== License and Trial ====== | ====== License and Trial ====== | ||
| - | When Eclipse started the first time after [[https://eplug.sibvisions.com/|EPlug]] has been installed, a prompt is opened to either select a commercial license file from the local disk or to request a new trial license from the license server. | + | When Eclipse started the first time after EPlug has been installed, a prompt is opened to either select a commercial license file from the local disk or to request a new trial license from the license server. |
| {{:visionx:eplug_guide:first-run-license-selector.png?nolink|The trial window as it appears upon first run of Eclipse with EPlug.}} | {{:visionx:eplug_guide:first-run-license-selector.png?nolink|The trial window as it appears upon first run of Eclipse with EPlug.}} | ||
| Line 51: | Line 51: | ||
| ====== Using EPlug ====== | ====== Using EPlug ====== | ||
| - | For all features to be available, [[https://eplug.sibvisions.com/|EPlug]] must be activated on the current project. This can be done through the First Run Wizard which is displayed when Eclipse is started the first time after the [[https://eplug.sibvisions.com/|EPlug]] installation. | + | For all features to be available, EPlug must be activated on the current project. This can be done through the First Run Wizard which is displayed when Eclipse is started the first time after the EPlug installation. |
| {{:visionx:eplug_guide:first-run-project-selector.png?nolink|The first run wizard which allows to activate EPlug on projects.}} | {{:visionx:eplug_guide:first-run-project-selector.png?nolink|The first run wizard which allows to activate EPlug on projects.}} | ||
| - | Select all projects on which you want to enable [[https://eplug.sibvisions.com/|EPlug]] and press "OK". | + | Select all projects on which you want to enable EPlug and press "OK". |
| - | Afterwards [[https://eplug.sibvisions.com/|EPlug]] can be activated on single projects through the project context menu. | + | Afterwards, EPlug can be activated on single projects through the project context menu. |
| {{:visionx:eplug_guide:project-context-menu.png?nolink|The the project context menu showing the option to activate EPlug on this project.}} | {{:visionx:eplug_guide:project-context-menu.png?nolink|The the project context menu showing the option to activate EPlug on this project.}} | ||
| Line 67: | Line 67: | ||
| ===== Commands ===== | ===== Commands ===== | ||
| - | [[https://eplug.sibvisions.com/|EPlug]] provides various commands which can be used to navigate the project. These are either available from the context menu on a source file or can be assigned custom keybindings through the Eclipse preferences. | + | EPlug provides various commands which can be used to navigate the project. These are either available from the context menu on a source file or can be assigned custom keybindings through the Eclipse preferences. |
| {{:visionx:eplug_guide:eplug-context-menu.png?nolink|The EPlug context menu that can be accessed through the editor.}} | {{:visionx:eplug_guide:eplug-context-menu.png?nolink|The EPlug context menu that can be accessed through the editor.}} | ||
| Line 73: | Line 73: | ||
| ==== Open Declaration ==== | ==== Open Declaration ==== | ||
| - | Extends the Eclipse "Open Declaration" command to be able to also jump to the declarations of actions and server calls. Because it extends the built-in functionality, this can be used as a replacement of the built-in command. | + | Extends the Eclipse "Open Declaration" command to be able to also jump to the declarations of actions and server calls. Because it extends the built-in functionality, this can be used as a replacement for the built-in command. |
| - | ==== Go To Complement Class ==== | + | ==== Go to Complement Class ==== |
| Opens the complement class of the currently open file. | Opens the complement class of the currently open file. | ||
| Line 81: | Line 81: | ||
| The complement class is the "counterpart" of every class on the client or server. So, when invoked on a workscreen (client-side), it will open the server-side LCO class and vice versa. | The complement class is the "counterpart" of every class on the client or server. So, when invoked on a workscreen (client-side), it will open the server-side LCO class and vice versa. | ||
| - | ==== Go To application.xml ==== | + | ==== Go to application.xml ==== |
| Opens the ''%%application.xml%%'' file of the project. | Opens the ''%%application.xml%%'' file of the project. | ||
| - | ==== Go To config.xml ==== | + | ==== Go to config.xml ==== |
| Opens the client-side ''%%config.xml%%'' file of the project. | Opens the client-side ''%%config.xml%%'' file of the project. | ||
| - | ==== Go To Server config.xml ==== | + | ==== Go to Server config.xml ==== |
| Opens the server-side ''%%config.xml%%'' file of the project. | Opens the server-side ''%%config.xml%%'' file of the project. | ||
| - | ==== Go To web.xml ==== | + | ==== Go to web.xml ==== |
| Opens the ''%%web.xml%%'' file of the project. | Opens the ''%%web.xml%%'' file of the project. | ||
| Line 99: | Line 99: | ||
| ==== Check File ==== | ==== Check File ==== | ||
| - | Runs all [[https://eplug.sibvisions.com/|EPlug]] checks on the file without building it anew. | + | Runs all EPlug checks on the file without building it anew. |
| ===== DataBooks ===== | ===== DataBooks ===== | ||
| - | The biggest and most important feature of [[https://eplug.sibvisions.com/|EPlug]] is the support for DataBooks, both ''%%RemoteDataBook%%''s and ''%%MemDataBook%%''s to be exact. | + | The biggest and most important feature of EPlug is the support for DataBooks, both ''%%RemoteDataBook%%''s and ''%%MemDataBook%%''s to be exact. |
| - | Because DataBooks use ''%%String%%''s to identify columns (instead of properties or Enums), it cannot be covered by the default functionality of Eclipse and the Java compiler. [[https://eplug.sibvisions.com/|EPlug]] extends Eclipse with additional functionality to be able to provide various features on and around DataBooks and column names. | + | Because DataBooks use ''%%String%%''s to identify columns (instead of properties or Enums), it cannot be covered by the default functionality of Eclipse and the Java compiler. EPlug extends Eclipse with additional functionality to be able to provide various features on and around DataBooks and column names. |
| Both the ''%%RemoteDataBook%%'' and the ''%%MemDataBook%%'' are supported out of the box. In the case of a ''%%MemDataBook%%'', the metadata is not requested from the data source (because there is none), but the metadata is directly extracted from the code itself. | Both the ''%%RemoteDataBook%%'' and the ''%%MemDataBook%%'' are supported out of the box. In the case of a ''%%MemDataBook%%'', the metadata is not requested from the data source (because there is none), but the metadata is directly extracted from the code itself. | ||
| Line 179: | Line 179: | ||
| ===== Actions ===== | ===== Actions ===== | ||
| - | Another pillar of [[https://eplug.sibvisions.com/|EPlug]] is the support for actions. Actions are a simple mechanism which provide the ability to use method references by specifying an object and the name of the method. The ability to use "real" method references has only lately become an integrated functionality of the JRE and of course [[https://jvx.sibvisions.com/|JVx]] does also support this. | + | Another pillar of EPlug is the support for actions. Actions are a simple mechanism which provide the ability to use method references by specifying an object and the name of the method. The ability to use "real" method references has only lately become an integrated functionality of the JRE and of course [[https://jvx.sibvisions.com/|JVx]] does also support this. |
| - | Out of the box the [[https://eplug.sibvisions.com/|EPlug]] support for actions does support all ''%%EventHandler%%'' extensions and various other methods. | + | Out of the box the EPlug support for actions does support all ''%%EventHandler%%'' extensions and various other methods. |
| - | ==== Compile time checks ==== | + | ==== Compile Time Checks ==== |
| The action names and references are checked during compilation for their existence and correct signature. | The action names and references are checked during compilation for their existence and correct signature. | ||
| Line 191: | Line 191: | ||
| Quick fixes are provided in the case that a method name has been misspelled or is non-existent. | Quick fixes are provided in the case that a method name has been misspelled or is non-existent. | ||
| - | ==== Hover tips ==== | + | ==== Hover Tips ==== |
| When hovering over the action name, a basic hover tip is provided which displays the most important information about the function. | When hovering over the action name, a basic hover tip is provided which displays the most important information about the function. | ||
| Line 197: | Line 197: | ||
| {{:visionx:eplug_guide:actions-hover-tip.png?nolink|The hover tip of an action showing the function signature.}} | {{:visionx:eplug_guide:actions-hover-tip.png?nolink|The hover tip of an action showing the function signature.}} | ||
| - | ==== Code completion ==== | + | ==== Code Completion ==== |
| Action listener names are also offered in the code completion dialog. | Action listener names are also offered in the code completion dialog. | ||
| Line 205: | Line 205: | ||
| ==== Templates ==== | ==== Templates ==== | ||
| - | To make it easier to create and add listeners, two templates are available from the code completion list which automatically create listener methods when chosen. | + | To make it easier to create and add listeners, two templates are available from the code completion list that automatically create listener methods when chosen. |
| {{:visionx:eplug_guide:actions-template.png?nolink|The code completion of Eclipse showing the two templates that can be inserted.}} | {{:visionx:eplug_guide:actions-template.png?nolink|The code completion of Eclipse showing the two templates that can be inserted.}} | ||
| Line 213: | Line 213: | ||
| {{:visionx:eplug_guide:actions-template-inserted.png?nolink|The source of the workscreen with the newly inserted function.}} | {{:visionx:eplug_guide:actions-template-inserted.png?nolink|The source of the workscreen with the newly inserted function.}} | ||
| - | ==== Refactoring support ==== | + | ==== Refactoring Support ==== |
| - | When an action listener is refactored through the provided mechanisms of Eclipse, the references to it are automatically refactored, too. | + | When an action listener is refactored through the provided mechanisms of Eclipse, the references to it are automatically refactored too. |
| - | ===== Server calls/actions ===== | + | ===== Server Calls/Actions ===== |
| - | Through the connection of the application, it is possible to directly execute functions and actions on the server. [[https://jvx.sibvisions.com/|JVx]] allows to do this by specifying the function name to call on the server and appending the parameters for the to be called function. | + | Through the connection of the application, it is possible to directly execute functions and actions on the server. [[https://jvx.sibvisions.com/|JVx]] allows you to do this by specifying the function name to call on the server and appending the parameters for the to be called function. |
| - | ==== Compile time checks ==== | + | ==== Compile Time Checks ==== |
| The server calls/actions are checked during compilation for their existence and whether the correct parameters have been provided. | The server calls/actions are checked during compilation for their existence and whether the correct parameters have been provided. | ||
| Line 227: | Line 227: | ||
| {{:visionx:eplug_guide:server-calls-compile-time-check.png?nolink|The source of the workscreen showing a misspelled server side action.}} | {{:visionx:eplug_guide:server-calls-compile-time-check.png?nolink|The source of the workscreen showing a misspelled server side action.}} | ||
| - | ==== Hover tips ==== | + | ==== Hover Tips ==== |
| When hovering over the name of a server call/action, a basic hover tip is provided which displays the most important information about the function. | When hovering over the name of a server call/action, a basic hover tip is provided which displays the most important information about the function. | ||
| Line 233: | Line 233: | ||
| {{:visionx:eplug_guide:server-calls-hover-tip.png?nolink|The hover tip of a server call showing the function signature.}} | {{:visionx:eplug_guide:server-calls-hover-tip.png?nolink|The hover tip of a server call showing the function signature.}} | ||
| - | ==== Code completion ==== | + | ==== Code Completion ==== |
| Server calls/actions are also offered in the code completion dialog. | Server calls/actions are also offered in the code completion dialog. | ||
| Line 239: | Line 239: | ||
| {{:visionx:eplug_guide:server-calls-code-completion.png?nolink|The code completion of Eclipse showing the available server side functions}} | {{:visionx:eplug_guide:server-calls-code-completion.png?nolink|The code completion of Eclipse showing the available server side functions}} | ||
| - | ==== Build options ==== | + | ==== Build Options ==== |
| The build behavior can also be changed in the project preferences. | The build behavior can also be changed in the project preferences. | ||
| Line 245: | Line 245: | ||
| {{:visionx:eplug_guide:project-build-properties.png?nolink|The project build properties of EPlug.}} | {{:visionx:eplug_guide:project-build-properties.png?nolink|The project build properties of EPlug.}} | ||
| - | === Object parameters passed to server calls === | + | === Object Parameters Passed to Server Calls === |
| - | This option defines how the plugin should treat server calls/actions which are passed with ''%%Object%%''s as parameters and if it should issue a notice/warning/error or do nothing. | + | This option defines how the plugin should treat server calls/actions which are passed with ''%%Object%%''s as parameters and whether it should issue a notice/warning/error or do nothing. |
| - | This is an especially useful function when one does call a lot of server functions with parameters from DataBooks, let us assume the following server side function: | + | This is an especially useful function when one calls a lot of server functions with parameters from DataBooks. Let us assume the following server side function: |
| <code java> | <code java> | ||
| Line 277: | Line 277: | ||
| ===== Resources ===== | ===== Resources ===== | ||
| - | Resources, like embedded images or text files, are important to most applications. In the case of [[https://jvx.sibvisions.com/|JVx]] they mostly consist of images which are used to enhance the UI and are loaded through the ''%%UIImage%%'' facility. | + | Resources, like embedded images or text files, are important to most applications. In the case of [[https://jvx.sibvisions.com/|JVx]], they mostly consist of images which are used to enhance the UI and are loaded through the ''%%UIImage%%'' facility. |
| - | ==== Compile time checks ==== | + | ==== Compile Time Checks ==== |
| The paths of resources are checked during compilation for their existence. | The paths of resources are checked during compilation for their existence. | ||
| Line 285: | Line 285: | ||
| {{:visionx:eplug_guide:resources-compile-time-check.png?nolink|The source of the workscreen showing a misspelled resource name.}} | {{:visionx:eplug_guide:resources-compile-time-check.png?nolink|The source of the workscreen showing a misspelled resource name.}} | ||
| - | ==== Hover tips ==== | + | ==== Hover Tips ==== |
| When hovering over the path of a resource, a hover tip is provided which shows a preview of the image that is being referenced. | When hovering over the path of a resource, a hover tip is provided which shows a preview of the image that is being referenced. | ||
| Line 291: | Line 291: | ||
| {{:visionx:eplug_guide:resources-hover-tip.png?nolink|The hover tip of a resource showing a preview of the image.}} | {{:visionx:eplug_guide:resources-hover-tip.png?nolink|The hover tip of a resource showing a preview of the image.}} | ||
| - | ==== Code completion ==== | + | ==== Code Completion ==== |
| The paths of resources are also offered in the code completion dialog, complete with a preview of the image. | The paths of resources are also offered in the code completion dialog, complete with a preview of the image. | ||
| Line 299: | Line 299: | ||
| ===== Comments ===== | ===== Comments ===== | ||
| - | [[https://eplug.sibvisions.com/|EPlug]] offers an additional plugin which provides various utility methods regarding comments. | + | EPlug offers an additional plugin which provides various utility methods regarding comments. |
| - | ==== Code completion ==== | + | ==== Code Completion ==== |
| - | Code completion for the current class is offered while writing a comment, this includes the class name and all function names. | + | Code completion for the current class is offered while writing a comment. This includes the class name and all function names. |
| {{:visionx:eplug_guide:comments-code-completion.png?nolink|The code completion of Eclipse showing the class name and all functions inside a comment.}} | {{:visionx:eplug_guide:comments-code-completion.png?nolink|The code completion of Eclipse showing the class name and all functions inside a comment.}} | ||
| Line 313: | Line 313: | ||
| {{:visionx:eplug_guide:comments-separators.png?nolink|The code completion of Eclipse showing the default separators.}} | {{:visionx:eplug_guide:comments-separators.png?nolink|The code completion of Eclipse showing the default separators.}} | ||
| - | ===== Additional build options ===== | + | ===== Additional Build Options ===== |
| There are additional build options available in the project preferences. | There are additional build options available in the project preferences. | ||
| Line 319: | Line 319: | ||
| {{:visionx:eplug_guide:project-build-properties.png?nolink|The project build properties of EPlug.}} | {{:visionx:eplug_guide:project-build-properties.png?nolink|The project build properties of EPlug.}} | ||
| - | ==== Mixed use of client/server classes ==== | + | ==== Mixed Use of Client/Server Classes ==== |
| - | Allows to check whether client classes are used on the server or the other way round. | + | Allows you to check whether client classes are used on the server or the other way round. |
| - | In most deployment environments the client would have no access to the server classes, and vice versa the server would not have access to the client classes. As both sources are included in the development classpath, a mixup of the two can happen easily. This option provides means to make sure that this does not happen, or at least can be spotted before deployment. | + | In most deployment environments, the client would have no access to the server classes, and vice versa: the server would not have access to the client classes. As both sources are included in the development classpath, a mixup of the two can easily happen. This option provides a means to make sure that this does not happen, or at least so it can be spotted before deployment. |
| - | ==== Check complement files during build ==== | + | ==== Check Complement Files During Build ==== |
| - | Allows to enable that complement files are also checked during the build. | + | Allows you to enable that complement files are also checked during the build. |
| See [[#go_to_complement_class|Go To Complement Class]] for more information. | See [[#go_to_complement_class|Go To Complement Class]] for more information. | ||
| - | ====== Interaction with VisionX ====== | + | ====== Interaction With VisionX ====== |
| - | [[https://visionx.sibvisions.com/|VisionX]] is a rapid application development tool which let's you quickly create, edit and publish applications. It has the ability to interact with [[https://eplug.sibvisions.com/|EPlug]], and [[https://eplug.sibvisions.com/|EPlug]] can interact with [[https://visionx.sibvisions.com/|VisionX]] in a variety of ways. | + | [[https://visionx.sibvisions.com/|VisionX]] is a rapid application development tool which let's you quickly create, edit, and publish applications. It has the ability to interact with EPlug, and EPlug can interact with [[https://visionx.sibvisions.com/|VisionX]] in a variety of ways. |
| - | ===== Connecting with VisionX ===== | + | ===== Connecting With VisionX ===== |
| - | The connection to [[https://visionx.sibvisions.com/|VisionX]] can be toogled by clicking the menu item and selecting the option "VisionX Communication". | + | The connection to [[https://visionx.sibvisions.com/|VisionX]] can be toggled by clicking the menu item and selecting the option "VisionX Communication". |
| {{:visionx:eplug_guide:visionx-menu.png?nolink|The VisionX toolbar menu.}} | {{:visionx:eplug_guide:visionx-menu.png?nolink|The VisionX toolbar menu.}} | ||
| Line 345: | Line 345: | ||
| {{:visionx:eplug_guide:visionx-context-menu.png?nolink|The VisionX context menu that can be accessed in the editor.}} | {{:visionx:eplug_guide:visionx-context-menu.png?nolink|The VisionX context menu that can be accessed in the editor.}} | ||
| - | ===== Notifying of changes ===== | + | ===== Notification of Changes ===== |
| - | [[https://eplug.sibvisions.com/|EPlug]] has the ability to inform [[https://visionx.sibvisions.com/|VisionX]] that changes to the sources have occurred and that it should reload the application. That can be done manually by selecting the command from the menusor, the automatic reloading can be activated. | + | EPlug has the ability to inform [[https://visionx.sibvisions.com/|VisionX]] that changes to the sources have occurred, and that it should reload the application. That can be done manually by selecting the command from the menus, or the automatic reloading can be activated. |
| - | When automatic reloading is activated, [[https://visionx.sibvisions.com/|VisionX]] will automatically reload the application everytime a file in the project has been changed. | + | When automatic reloading is activated, [[https://visionx.sibvisions.com/|VisionX]] will automatically reload the application every time a file in the project has been changed. |
| - | ===== Synchronizing the selection ===== | + | ===== Synchronizing the Selection ===== |
| The selection between [[https://visionx.sibvisions.com/|VisionX]] can also be synchronized either manually, through the same menus, or by automatic means. | The selection between [[https://visionx.sibvisions.com/|VisionX]] can also be synchronized either manually, through the same menus, or by automatic means. | ||
| - | The selection in Eclipse is the position of the cursor in the text editor, the selection in [[https://visionx.sibvisions.com/|VisionX]] is the actual selection of components in the design mode. If design mode is not active in [[https://visionx.sibvisions.com/|VisionX]], it will not be turned on. | + | The selection in Eclipse is the position of the cursor in the text editor; he selection in [[https://visionx.sibvisions.com/|VisionX]] is the actual selection of components in the design mode. If design mode is not active in [[https://visionx.sibvisions.com/|VisionX]], it will not be turned on. |
| - | ===== Additional commands ===== | + | ===== Additional Commands ===== |
| There are various additional commands available to interact with [[https://visionx.sibvisions.com/|VisionX]]. | There are various additional commands available to interact with [[https://visionx.sibvisions.com/|VisionX]]. | ||
| Line 365: | Line 365: | ||
| ==== Edit in VisionX ==== | ==== Edit in VisionX ==== | ||
| - | The currently selected item or source file is also selected in [[https://visionx.sibvisions.com/|VisionX]], and the Design Mode is turned on in [[https://visionx.sibvisions.com/|VisionX]]. | + | The currently selected item or source file is also selected in [[https://visionx.sibvisions.com/|VisionX]], and the design mode is turned on in [[https://visionx.sibvisions.com/|VisionX]]. |
| ==== New Workscreen ==== | ==== New Workscreen ==== | ||