Scout/Concepts/CodeType

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/.

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.

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() and hashCode() 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.

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.

The Scout documentation has been moved to https://eclipsescout.github.io/. of a simple YesOrNoCodeType having just two codes:

• YesOrNoCodeType.YesCode
• YesOrNoCodeType.NoCode

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.

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/..

TODO
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).

public class YesOrNoSmartField extends AbstractSmartField<Boolean> {
  // other configuration of properties.
  @Override
  protected Class<? extends ICodeType<?>> getConfiguredCodeType(){
    return YesOrNoCodeType.class;
  }
}

If the SmartField (or SmartColumn) works with a CodeType, a specific LookupCall is instantiated to get the LookupRows based on the Codes contained in a CodeType.

Accessing a code directly

Scout-runtime will handle the instantiation and the caching of CodeType.

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 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/.