The Goal of This Example
Show how a Universal Display File can work in tandem with a Rich Display File's List Box Widget's choices URL property. You could also utilize the choices URL property within a Combo Box Widget, but this example will be using a List Box Widget.
Files Used by This Example
Below are downloadable versions of the files used in this example:
- Choices URL in Universal Display File: COLORSD.json
- Universal Display File RPG Code: COLORSR.txt
- Rich Display File: SHOWCOLORD.json
- Rich Dipslay File RPG Code: SHOWCOLORR.txt
The Universal Display File
Read more about it: Using the Universal Display File Editor
Below are screen shots of the Universal Display File being created the Universal Designer. There are 3 record formats representing the parts of an HTML page, the Header, Body, and Footer. The middle image shows CONAME
and COHEX
as the bound fields. CONAME
(color name) is the variable containing names of colors. COHEX
(color hex) is the variable containing the hex values of CONAME
's colors. Our Universal Display File will access the information in these bound fields and display them in our program. Please refer to the for more information with this step.
Header
The Header format is used to define the file/object being made by the Universal Display Program and is only printed once to the file/object. The Header format in this example defines the start of a JSON object
.
Body
The Body format is used to define a section of the file/object that will be printed one or more times depending on an input source. The Body format in this example defines an Option for the List Box and will be printed to the JSON object
as many times as there are records in the COLORSP
database file.
Footer
The Footer format is used to define the end of the file/object that will only be printed once. The Footer format in this example ends the JSON object
.
The Universal Display RPG Source Code
Read more about it: RPG Coding for Universal Display Files
The source code file of this example is named COLORSR
. An important part to mention is that the Universal Handler is used for this program.
What this program will do is grab a list of colors from a specified database file, COLORSP
for this example, on the IBM i
and create a JSON object
that will contain the option objects that will populate the List Box. CONAME
will display in the List Box and the corresponding COHEX
will be passed to the program when a selection is made.
Remember!
Hard coded libraries are a bad practice! We strongly suggest you do not use hard coded libraries!
The Rich Display File
Read more about it: Visual Designer Basics, Using the Web Connector, Work with URL Mappings Tool
Below is a screen shot of the layout of the SHOWCOLORD
rich display file. There are 3 bound fields. Two for OK
and EXIT
buttons, and one for the color bound field. Once you click the OK
button after selecting a color name in the List Box, the background color of the label underneath will change to the corresponding color. The COLOR
bound field is bound to the background color attribute of the label widget, and is also bound to the value property of the List Box; this is how the label is able to change colors accordingly.
The Choices URL property of the List Box is what populates the choices of colors that can be picked. We set this property to the URL of our Universal Display File application.
Example Display Arrangement
This is an image of the Visual Designer with the arrangement of elements of this example.
Remember!
Don't forget that the choices url value needs to mapped! The Web Connector, as of Profound UI 5.10.0, has a URL Mappings Tool that can be used to maintain the URL Mappings, previous versions require a PUIMAPP record to be created.
The Rich Display RPG Source Code
File name is SHOWCOLORR
. Notice that the ProfoundUI Handler is being used in the handler for this program. The EXFMT operation will display the SHOWCOLORD
display file.
Remember!
Hard coded libraries are a bad practice! We strongly suggest you do not use hard coded libraries!
The Result
After compiling the Universal Display File (COLORSD
) and the Rich Display File (SHOWCOLORD
) the corresponding RPG programs, COLORSR
and SHOWCOLORR
, may be compiled and the program run.
To run the program, login to a Genie session and use EDTLIBL
or ADDLIBLE
to make sure the libraries where the program files are stored are in the library list. Please make sure that PROFOUNDUI
is included in your library list. Then CALL YOURLIBRARY/SHOWCOLORR
. This will run your program and you can display the colors after highlighting a color name and pressing the Ok button.
The Program in Action
Why Do It This Way?
- Restful Aplications
- Security
- Object Oriented Design