Documentation

Trace:

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
visionx:eplug_guide [2020/06/05 17:02]
cduncan [Commands]
visionx:eplug_guide [2020/06/08 10:40] (current)
cduncan Edited for English grammar (capitalization, punctuation, correct verb conjugation)
Line 57: Line 57:
 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 [[https://​eplug.sibvisions.com/​|EPlug]] and press "​OK"​.
  
-Afterwards [[https://​eplug.sibvisions.com/​|EPlug]] can be activated on single projects through the project context menu.+Afterwards[[https://​eplug.sibvisions.com/​|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 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.
  
-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 classand vice versa.+The complement class is the "​counterpart"​ of every class on the client or server. Sowhen 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 105: Line 105:
 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 [[https://​eplug.sibvisions.com/​|EPlug]] is the support for DataBooks, both ''​%%RemoteDataBook%%''​s and ''​%%MemDataBook%%''​s to be exact.
  
-Because DataBooks ​are using ''​%%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. [[https://​eplug.sibvisions.com/​|EPlug]] extends Eclipse with additional functionality to be able to provide various features on and around DataBooks and column names.
  
-Boththe ''​%%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.
  
-==== Compile ​time checks ​====+==== Compile ​Time Checks ​====
  
-Column names are checked during compilation if they are correct or not. This is done by actually requesting the metadata from the data source and comparing the names against it. In the case of the ''​%%MemDataBook%%''​ the metadata is built directly from the code.+Column names are checked during compilation if they are correct or not. This is done by actually requesting the metadata from the data source and comparing the names against it. In the case of the ''​%%MemDataBook%%''​the metadata is built directly from the code.
  
 {{:​visionx:​eplug_guide:​databook-compile-time-check.png?​nolink|The workscreen source with a mistyped column name being highlighted.}} {{:​visionx:​eplug_guide:​databook-compile-time-check.png?​nolink|The workscreen source with a mistyped column name being highlighted.}}
Line 117: Line 117:
 Quick fixes are provided in the case that a column name has been misspelled to make it easier to fix simple errors. Quick fixes are provided in the case that a column name has been misspelled to make it easier to fix simple errors.
  
-==== Hover tips ====+==== Hover Tips ====
  
-When hovering over a column name, a hover tip is displayed ​which shows all the information about the column that is available. The information includes:+When hovering over a column name, a hover tip is displayed ​that shows all the information about the column that is available. The information includes:
  
   * Name   * Name
Line 129: Line 129:
 {{:​visionx:​eplug_guide:​databook-hover-tip.png?​nolink|The hover tip of a column name showing various informations and properties of the column.}} {{:​visionx:​eplug_guide:​databook-hover-tip.png?​nolink|The hover tip of a column name showing various informations and properties of the column.}}
  
-==== Code completion ​====+==== Code Completion ​====
  
-Column names are also offered in the code completion dialog, complete with all available information about them.+Column names are also offered in the code completion dialog ​as well as all available information about them.
  
 {{:​visionx:​eplug_guide:​databook-code-completion.png?​nolink|The code completion of Eclipse showing column names for the current DataBook.}} {{:​visionx:​eplug_guide:​databook-code-completion.png?​nolink|The code completion of Eclipse showing column names for the current DataBook.}}
Line 137: Line 137:
 The same information as in the hover tips is being displayed alongside all columns that can be selected in the code completion dialog. The same information as in the hover tips is being displayed alongside all columns that can be selected in the code completion dialog.
  
-==== DataBooks ​view ====+==== DataBooks ​View ====
  
-Additionally there is the DataBooks ​View, which does list all DataBooks and all columns in the currently edited file together with their datatype and label.+Additionallythere is the DataBooks ​view which lists all DataBooks and all columns in the currently edited file together with their datatype and label.
  
 {{:​visionx:​eplug_guide:​databooks-view.png?​nolink|The DataBooks View displaying the currently used DataBooks.}} {{:​visionx:​eplug_guide:​databooks-view.png?​nolink|The DataBooks View displaying the currently used DataBooks.}}
Line 151: Line 151:
 {{:​visionx:​eplug_guide:​project-properties-databook.png?​nolink|The project preferences with the DataBook node selected.}} {{:​visionx:​eplug_guide:​project-properties-databook.png?​nolink|The project preferences with the DataBook node selected.}}
  
-=== Check the DataBooks on refresh ​===+=== Check the DataBooks on Refresh ​===
  
-When enabled, DataBooks are checked when a refresh of the file is performednot only when the file is build.+When enabled, DataBooks are checked when a refresh of the file is performed ​and not only when the file is build.
  
-=== Check DataBooks ​while you type ===+=== Check DataBooks ​While You Type ===
  
 When enabled, DataBooks are checked as you type without the need to save and/or build the file. When enabled, DataBooks are checked as you type without the need to save and/or build the file.
Line 161: Line 161:
 This is especially useful when working with ''​%%MemDataBook%%''​s,​ as their metadata might have been typed just seconds before being used. This is especially useful when working with ''​%%MemDataBook%%''​s,​ as their metadata might have been typed just seconds before being used.
  
-==== 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 167: Line 167:
 {{:​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.}}
  
-=== Action ​when no metadata was provided ​===+=== Action ​When No Metadata Was Provided ​===
  
-This option allows to control how the plugin behaves when no metadata could be acquired for the DataBook that is being checked. Please note that "no metadata could be acquired"​ is not the same as "​acquiring failed"​, for example it could be that a DataBook is the parameter of a function. In that case is not possible to determine from where the DataBook originated, so no metadata can be determined.+This option allows ​you to control how the plugin behaves when no metadata could be acquired for the DataBook that is being checked. Please note that "no metadata could be acquired"​ is not the same as "​acquiring failed"​. For exampleit could be that a DataBook is the parameter of a function. In that caseis not possible to determine from where the DataBook originated, ​and so no metadata can be determined.
  
 With this option, the behavior for such a situation can be controlled, whether the plugin should issue a notice/​warning/​error or do nothing. With this option, the behavior for such a situation can be controlled, whether the plugin should issue a notice/​warning/​error or do nothing.
Line 175: Line 175:
 === Check DataSource of RemoteDataBooks === === Check DataSource of RemoteDataBooks ===
  
-This option allows to control whether the datasource on ''​%%RemoteDataBook%%''​s should be checked if it is correctly set or not. This is basically a check whether ​the name of the ''​%%RemoteDataBook%%''​ can be mapped to a server-side storage object.+This option allows ​you to control whether the datasource on ''​%%RemoteDataBook%%''​s should be checked if it is correctly set or not. This is basically a check if the name of the ''​%%RemoteDataBook%%''​ can be mapped to a server-side storage object.
  
 ===== Actions ===== ===== Actions =====
Line 183: Line 183:
 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 [[https://​eplug.sibvisions.com/​|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 refactoredtoo.+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 301: Line 301:
 [[https://​eplug.sibvisions.com/​|EPlug]] offers an additional plugin which provides various utility methods regarding comments. [[https://​eplug.sibvisions.com/​|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 environmentsthe client would have no access to the server classes, and vice versathe 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 ​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, editand 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.
  
-===== 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.+[[https://​eplug.sibvisions.com/​|EPlug]] has the ability to inform [[https://​visionx.sibvisions.com/​|VisionX]] that changes to the sources have occurredand that it should reload the application. That can be done manually by selecting the command from the menusor 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 ====
This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information