Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/Concepts/CodeType"
m (→See Also) |
(First version) |
||
| Line 1: | Line 1: | ||
{{ScoutPage|cat=Concepts}} | {{ScoutPage|cat=Concepts}} | ||
| − | + | A CodeType is a structure to represent a tree key-{{ScoutLink|Concepts|Code|code}} association. They are used in {{ScoutLink|Concepts|SmartField|SmartField}} and {{ScoutLink|Concepts|SmartColumn|SmartColumn}}. | |
| − | * implements: {{ScoutJavadoc|< | + | * implements: {{ScoutJavadoc|ICodeType<T>|I}} |
| − | * extends: {{ScoutJavadoc|< | + | * extends: {{ScoutJavadoc|AbstractCodeType<T>|C}} |
| − | |||
| − | |||
| + | ==Structure of a CodeType== | ||
| − | + | CodeType are used in SmartField to let the user choose between a finish list of values. The value stored by the field correspond to the key of the selected code. In order to have the same resolving mechanism (getting the display text of a key) CodeType are also used in SmartColumn. | |
| − | + | ||
| + | {{note|TODO|Screenshot of a SmartField using a ColorCodeType}} | ||
| − | + | A CodeType can be seen as a tree of {{ScoutLink|Concepts|Code|Codes}}. A code has a Key (the {{ScoutProp|Id}}), which type is defined by its generic parameter <code><T></code>. It is very common to use a type from the <code>java.lang.*</code> package (like <code>Integer</code> or <code>String</code>) but any Java Object is suitable. It must: | |
| − | + | * implements <code>Serializable</code> | |
| + | * have correctly implemented <code>equals()</code> and <code>hashCode()</code> functions | ||
| + | * present in the server and the client | ||
| − | + | The code associate to the key other properties: among others a {{ScoutProp|Text}} and an {{ScoutProp|IconId}}. | |
| + | The codes are organized in a tree. Therefore a CodeType can have one or more child codes at the root level, and each code can have other child codes. In lot of cases a list of codes (meaning a tree containing only leafs at the first level) is sufficient to cover most of the need. | ||
| − | + | Child codes are ordered in their parent code. This is realized with the {{ScoutLink|Concepts|Order Annotation|order annotation}}. | |
| − | + | ||
| − | {{note|TODO| | + | There is no obligation to have the same type for the {{ScoutProp|Id}} between the codes of a CodeType (meaning the same generic type parameter for the codes inner-class). However it is a good practice to have the same type between the codes of a CodeType, because the Id are used as value of {{ScoutLink|Concepts|SmartField|SmartFields}}. Therefore the generic parameter describing the type of value of a SmartField must be compatible with the type of the codes contained in the CodeType. |
| + | |||
| + | {{note|TODO|Representation of the color code}} | ||
| + | |||
| + | |||
| + | == A CodeType Class == | ||
| + | The common way to define a CodeType is to extend AbstractCodeType. Each code is an inner-class extending AbstractCode. Like usual the properties of Codes and CodeTypes can be set with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods. | ||
| + | |||
| + | {{note|TODO|Code of a simple YesNoCodeType<Boolean>}} | ||
| + | |||
| + | |||
| + | The SDK provides some help to generate CodeTypes and Codes. The CodeType appears in the {{ScoutLink|SDK|Explorer View|Explorer View}} in the '''Enumerations''' folder under shared. It is possible to add a new with a wizard. | ||
| + | |||
| + | {{note|TODO|Screenshot du YesNoCodeType in the SDK}} | ||
| + | |||
| + | Scout does not require to have this inner-class hard-coded structure for CodeTypes. It is possible to implement other mechanisms to load CodeType. The description of the Codes can come from a database or from an XML files. If you want to do so, you just need to implement the method corresponding to the event {{ScoutEvent|LoadCodes}}. | ||
| + | |||
| + | {{note|TODO| Describe good organization of classes to load codeType from an XML File. With small UML graph}} | ||
| + | |||
| + | ==Using a CodeType== | ||
| + | |||
| + | === SmartField or SmartColumn === | ||
| + | {{ScoutProp|CodeType}} in a SmartField (or SmartColumn). | ||
| + | {{note|TODO|Code}} | ||
| + | |||
| + | If the SmartField (or SmartComuln) works with a CodeType, a specific LookupCall is instantiated to get the LookupRow based on the Codes contained in a CodeType. | ||
| + | |||
| + | ===Accessing a code directly === | ||
| + | Scout-runtime will handle the instantiation and the caching of CodeType. | ||
| + | |||
| + | {{note|TODO|Code CODES.getCodeType(...) + getCode + null check + getText}} | ||
| + | |||
| + | |||
| + | '''Note for advanced users:''' | ||
| + | |||
| + | Each CodeType is instantiated for | ||
| + | * each language | ||
| + | * each partition | ||
| + | |||
| + | Note: A drawback that the CodeType Class is not aware of the language and the partition it is instantiate for. Only the {{ScoutJavadoc|CodeTypeStore|C}} that manage the CodeType instances knows for which language and which partition they have been instantiated. | ||
Revision as of 15:30, 9 November 2010
The Scout documentation has been moved to https://eclipsescout.github.io/.
A CodeType is a structure to represent a tree key-The Scout documentation has been moved to https://eclipsescout.github.io/. association. They are used in The Scout documentation has been moved to https://eclipsescout.github.io/. and The Scout documentation has been moved to https://eclipsescout.github.io/..
- implements: The Scout documentation has been moved to https://eclipsescout.github.io/.
- extends: The Scout documentation has been moved to https://eclipsescout.github.io/.
Contents
Structure of a CodeType
CodeType are used in SmartField to let the user choose between a finish list of values. The value stored by the field correspond to the key of the selected code. In order to have the same resolving mechanism (getting the display text of a key) CodeType are also used in SmartColumn.
Screenshot of a SmartField using a ColorCodeType
A CodeType can be seen as a tree of The Scout documentation has been moved to https://eclipsescout.github.io/.. A code has a Key (the The Scout documentation has been moved to https://eclipsescout.github.io/.), which type is defined by its generic parameter <T>. It is very common to use a type from the java.lang.* package (like Integer or String) but any Java Object is suitable. It must:
- implements
Serializable - have correctly implemented
equals()andhashCode()functions - present in the server and the client
The code associate to the key other properties: among others a The Scout documentation has been moved to https://eclipsescout.github.io/. and an The Scout documentation has been moved to https://eclipsescout.github.io/..
The codes are organized in a tree. Therefore a CodeType can have one or more child codes at the root level, and each code can have other child codes. In lot of cases a list of codes (meaning a tree containing only leafs at the first level) is sufficient to cover most of the need.
Child codes are ordered in their parent code. This is realized with the The Scout documentation has been moved to https://eclipsescout.github.io/..
There is no obligation to have the same type for the The Scout documentation has been moved to https://eclipsescout.github.io/. between the codes of a CodeType (meaning the same generic type parameter for the codes inner-class). However it is a good practice to have the same type between the codes of a CodeType, because the Id are used as value of The Scout documentation has been moved to https://eclipsescout.github.io/.. Therefore the generic parameter describing the type of value of a SmartField must be compatible with the type of the codes contained in the CodeType.
Representation of the color code
A CodeType Class
The common way to define a CodeType is to extend AbstractCodeType. Each code is an inner-class extending AbstractCode. Like usual the properties of Codes and CodeTypes can be set with The Scout documentation has been moved to https://eclipsescout.github.io/. methods.
Code of a simple YesNoCodeType<Boolean>
The SDK provides some help to generate CodeTypes and Codes. The CodeType appears in the The Scout documentation has been moved to https://eclipsescout.github.io/. in the Enumerations folder under shared. It is possible to add a new with a wizard.
Screenshot du YesNoCodeType in the SDK
Scout does not require to have this inner-class hard-coded structure for CodeTypes. It is possible to implement other mechanisms to load CodeType. The description of the Codes can come from a database or from an XML files. If you want to do so, you just need to implement the method corresponding to the event The Scout documentation has been moved to https://eclipsescout.github.io/..
Describe good organization of classes to load codeType from an XML File. With small UML graph
Using a CodeType
SmartField or SmartColumn
The Scout documentation has been moved to https://eclipsescout.github.io/. in a SmartField (or SmartColumn).
Code
If the SmartField (or SmartComuln) works with a CodeType, a specific LookupCall is instantiated to get the LookupRow based on the Codes contained in a CodeType.
Accessing a code directly
Scout-runtime will handle the instantiation and the caching of CodeType.
Code CODES.getCodeType(...) + getCode + null check + getText
Note for advanced users:
Each CodeType is instantiated for
- each language
- each partition
Note: A drawback that the CodeType Class is not aware of the language and the partition it is instantiate for. Only the The Scout documentation has been moved to https://eclipsescout.github.io/. that manage the CodeType instances knows for which language and which partition they have been instantiated.
See Also
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.