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:eplug_guide [2020/06/05 17:06] cduncan [Go To Complement Class] |
visionx:eplug_guide [2020/06/05 17:32] cduncan [Preferences] |
||
---|---|---|---|
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. |
- | 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. |
- | ==== 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. | + | Additionally, there 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 performed, not 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. |