Cada tipo de registro se explica a continuación. Un campo dentro de un tipo de registro puede ser de lectura y escritura o sólo de lectura. Un campo solo de lectura permite al usuario consultar pero no cambiar los valores de atributo. Un campo de lectura/escritura permite al usuario consultar y cambiar los valores.
Tipo Window
Cada ConsoleUI puede tener varias ventanas abiertas simultáneamente. La ventana por omisión y primera ventana que se abre es una ventana de pantalla completa, llamada pantalla. Las ventanas abiertas después de esta se apilarán unas sobre otras; la ventana superior es la ventana activa. Cuando se cierra la ventana activa, la ventana que queda encima de las otras es la nueva ventana activa.
La tabla siguiente define los atributos de los campos de Window. Solo es obligatorio el atributo name.
Atributos | Tipo de enumeración | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
color | colorKind | black | Sí, cuando es visible | El color del texto de la ventana. |
commentLine | integer | pantalla: LAST - 1; otros: LAST | Sí, cuando es visible | Si una línea específica se reserva o no para comentarios. Si hasCommentLine = yes, la línea de ventana se utiliza para comentarios. |
formLine | entero (positivo) Un entero negativo puede utilizarse para especificar el número de línea empezando desde la parte inferior de la pantalla; los valores de línea solo se validan en tiempo de ejecución. |
3 | Sí, cuando es visible | La línea de la ventana en la que empieza un formulario. |
hasBorder | boolean | no | Sí, cuando es visible | Si una ventana tiene marco o no. |
hasComment línea | boolean | sí | Sí, cuando es visible | Si una línea se reserva o no para comentarios. |
highlight | highlightKind | black | Sí, cuando es visible | El resaltado aplicado al texto de la ventana. |
intensity | intensityKind | Intensidad normal | Sí, cuando es visible | La intensidad (negrita) que se desea aplicar al texto de la ventana. |
menuLine | entero (positivo) Un entero negativo puede utilizarse para especificar el número de línea empezando desde la parte inferior de la pantalla; los valores de línea dentro del tamaño de la ventana solo se validarán en tiempo de ejecución. |
1 | Sí, cuando es visible | La línea de la ventana en la que empieza un menú. |
messageLine | entero (positivo) Un entero negativo puede utilizarse para especificar el número de línea empezando desde la parte inferior de la pantalla; los valores de línea solo se validan en tiempo de ejecución. |
2 | Sí, cuando es visible | La línea de la ventana reservada para mensajes. |
name | string | none | Sí | El nombre de la ventana. |
position | integer[2] Debe ser un entero positivo mayor que cero y dentro de las dimensiones físicas del dispositivo de pantalla. |
[1,1] | Sí | La posición de la esquina superior izquierda de la pantalla. |
promptLine | entero (positivo) Un entero negativo puede utilizarse para especificar el número de línea empezando desde la parte inferior de la pantalla; los valores de línea dentro del tamaño de la ventana solo se validarán en tiempo de ejecución. |
1 | Sí, cuando es visible | La línea de la ventana reservada para solicitudes. |
size | integer[2] Debe ser un entero positivo mayor que cero y dentro de las dimensiones físicas del dispositivo de pantalla. |
none | Sí | El número de filas y columnas de la ventana. Si no se especifica, se calculará el tamaño en tiempo de ejecución. |
Tipo PresentationAttributes
PresentationAttributes definen el aspecto del texto de la ventana.
La tabla siguiente define los atributos de los campos de PresentationAttributes. Ninguno de los atributos es obligatorio.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
color | colorKind | white | No | El color del mensaje de texto. |
highlight | highlightKind | none | No | El resaltado que desea aplicar al mensaje de texto. Puede combinar
cualquiera de los atributos siguientes:
|
intensity | intensityKind | Intensidad normal | No | La intensidad que se desea aplicar al mensaje de texto. |
Tipo ConsoleForm
Un registro ConsoleForm es un registro que define las propiedades del formulario en la ventana. Cada ventana puede mostrar un ConsoleForm individual.
La tabla siguiente define los atributos de las propiedades de ConsoleForm. Ninguno de los atributos es obligatorio.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
delimiters | char[3] | "[]|" | Sí | Los caracteres utilizados para delimitar campos. Los corchetes izquierdo "[" y derecho "]" son necesarios. La barra "|" se utiliza si solo un espacio separa dos campos. |
formSize | integer[2] | none | Sí | Tamaño del formulario: filas, columnas. |
name | string | Si no se ha especificado name, EGL proporciona un nombre. | Sí | El nombre del formulario. |
showBrackets | boolean | sí | Sí | Los corchetes delimitan los campos. |
ConsoleField
Las propiedades de ConsoleField definen todos los atributos presentados para el formulario.
La tabla siguiente define los atributos de las propiedades de ConsoleField. Solo son obligatorios los atributos fieldLen y position.
Nombre de propiedad | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
columns | integer | 1 | Sí | El número de columnas. Solo es válido en los campos de matriz de consola. |
fieldLen | integer | Número de bytes necesarios para visualizar el valor más grande en la declaración de tipo con todos los caracteres de formato presentes. | Sí | El número de columnas ocupado por el campo. |
linesBetween Filas | integer | 0 | Sí | El número de líneas entre cada fila. Solo es válido en los campos de matriz de consola. |
orientIndex Entre | boolean | No | Sí | La orientación de los campos dentro del formulario. Solo es válido en los campos de matriz de consola. |
position | integer[2] | [1,1] | Sí | La posición del campo en el formulario. |
segments | integer[3][] | Sí | Conjunto de posición y longitud para cada segmento de campo. Si no es nulo, altera temporalmente la posición y la longitud. | |
spacesBetween Columnas | integer | 1 | Sí | El número de espacios entre columnas. Solo es válido en los campos de matriz de consola. |
validValues | Especificación de validValue | Sí, cuando se muestra | Alberga la lista de valores válidos para la entrada en este campo de formulario |
La tabla siguiente define los atributos de los campos de ConsoleField. Solo es obligatorio el atributo name.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
align | alignKind | depende del tipo | Sí | Especifica la alineación de valores en el campo:
|
autonext | boolean | none | Sí | Si el cursor debe moverse o no al campo siguiente si el campo está cumplimentado. Si autonext = yes, el cursor se mueve al campo siguiente. |
binding | string | "" | Sí, cuando se muestra | Alberga la referencia al elemento de datos enlazado a este campo |
caseFormat | caseFormatKind | Valor por omisión mayús./minús. | No | Especifica si el valor debe pasar de minúsculas a mayúsculas o de mayúsculas a minúsculas. Cuando está seleccionado una renovación de campo implementará el valor nuevo. |
color | colorKind | white | No | Igual que el campo de formulario de texto. El color puede establecerse dinámicamente en cualquier momento y el campo de formulario visualizará los atributos de presentación cuando se renueve el campo o cuando éste obtenga el foco durante la interacción del usuario. |
commentKey | string | none | Sí | La tecla para buscar el texto de comentario en un recurso. |
comment | string | none | Sí | El texto de comentario para este campo que se visualiza en la línea de comentario cuando el cursor está en el campo. |
dataType | string | "" | Sí | Define el tipo de datos de este campo de formulario cuando el campo de formulario no se ha enlazado a un elemento de datos. Obligatorio para constructQuery. |
dateFormat | string | Sí | Formatea el campo según el valor de formato de fecha especificado.
Los valores posibles son:
|
|
editor | string | none | Sí | Se utiliza para editar los tipos LOB (objeto largo) del campo. |
helpMsgKey | string | "" | No | Tecla que busca en el texto de ayuda de un archivo de recursos. Si help y helpMsgKey están presentes, help tiene preferencia. |
help | string | "" | No | Texto que se muestra al usuario cuando se pulsa la tecla KEY_HELP. Si help y helpMsgKey están presentes, help tiene preferencia. |
highlight | resaltado por omisión | none | No | Igual que el campo de formulario de texto. El color puede establecerse dinámicamente en cualquier momento y el campo de formulario visualizará los atributos de presentación cuando se renueve el campo o cuando éste obtenga el foco durante la interacción del usuario. |
initialValueKey | string | none | Sí | La tecla utilizada para buscar initialValue. |
initialValue | string | none | Sí | El valor de visualización inicial del campo. |
inputRequired | boolean | false | Sí | Si se establece, el usuario debe especificar un valor en el campo. El usuario no puede dejar el campo vacío. |
intensity | Intensidad normal | none | No | Igual que el campo de formulario de texto. El color puede establecerse dinámicamente en cualquier momento y el campo de formulario visualizará los atributos de presentación cuando se renueve el campo o cuando éste obtenga el foco durante la interacción del usuario. |
isBoolean | boolean | no | Sí | Indica que el campo representa un valor booleano. El valor se representa como
un carácter dependiente del idioma nacional (un campo de caracteres) o una palabra para "yes" o
"no". Internamente, para campos numéricos:
|
masked | boolean | none | Sí | Si se establece, cada carácter del campo se visualiza como un solo asterisco (*). |
minimumInput | integer | no | Sí | Especifica el número mínimo de caracteres que deben estar presentes en el valor especificado por el usuario. |
name | string | none | Sí | El nombre del campo. |
numericFormat | string | Sí | Formatea el campo según los valores de formato numéricos especificados.
Los valores de caracteres posibles son:
|
|
pattern | string | Sí | Especifica el patrón para el formateo y la entrada de datos. | |
protect | boolean | none | No | Si es yes, el usuario no puede especificar datos en el campo. Si es no, el usuario puede especificar datos en el campo. |
SQLColumnName | string | "" | No | El valor de serie que representa el nombre de una columna en una tabla de base de datos. Esta información se utiliza durante la consulta de construcción, en la que el nombre de columna se utiliza en la serie SQL generada. Si está presente, este valor tiene preferencia sobre el valor del nombre de la columna dataType. |
timeFormat | string | Sí | Formatea el campo según el valor de formato de hora especificado.
Los valores posibles son:
|
|
timeStampFormat | string | Sí | Formatea el campo según el valor de formato de indicación de la hora
especificado. Los valores posibles son:
|
|
value | string | none | Sí | El contenido del almacenamiento intermedio de visualización actual para el campo. |
verify | boolean | false | Sí | Si está establecido, cuando el usuario modifica el campo, se solicita al usuario que vuelva a entrar el mismo valor para poder salir del campo. |
wordWrap | integer | none | Sí | Cómo se dividen los valores en un campo de varios segmentos:
|
Menu
Cada ventana puede visualizar un Menú individual que puede tener un número ilimitado de menuItem. Los usuarios finales se moverán por el menú y seleccionarán el elemento de menú (menuitem) deseado que ejecutará la acción on_event asociada al menuItem en el programa EGL.
La tabla siguiente define los atributos de los campos de Menu. Solo son obligatorios los atributos labelText y labelKey.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
labelText | string | Sí, durante la ejecución de OpenUI | El nombre del menú en la pantalla. | |
labelKey | string | Sí, durante la ejecución de OpenUI | La tecla que busca el título del menú en un recurso. Si se proporciona un valor para label, no se tiene en cuenta labelKey. | |
menuItems | menu Item[] | No | Contiene una matriz dinámica de menuItems asociados a este menú. Si menuItems no está implementado, los elementos de menú deben añadirse utilizando la sintaxis menu.MenuItems.addElement(menuItem). Si no existen elementos de menú cuando se llama openUI con el objeto de menú, se lanza un error de tiempo de ejecución. |
MenuItem
MenuItem, todos los atributos definen el menú.
La tabla siguiente define los atributos de los campos MenuItem. Solo es obligatorio el atributo name.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
accelerators | string[] | Sí | Los nombres de los aceleradores (combinaciones de teclas) que activan el elemento. | |
commentKey | string | Sí | La tecla que busca el comentario en un recurso. Este valor se pasa por alto si se proporciona un comment. | |
comment | string | Sí | El texto que se visualizará en la línea de comentario cuando se seleccione el elemento en la pantalla. | |
helpMsgKey | string | Sí | La tecla que busca la ayuda en un recurso. Este valor se pasa por alto si se proporciona help | |
help | string | Sí | El texto a visualizar cuando se selecciona la tecla de ayuda | |
labelKey | string | Sí | La tecla que busca la etiqueta en un recurso. Este valor se pasa por alto si se proporciona labelText | |
labelText | string | Sí | El nombre de visualización del elemento. | |
name | string | Sí | El nombre del elemento. Este nombre se utiliza durante el proceso de OnEvent. Si no se especifica el nombre, un algoritmo interno calculará uno. |
Prompt
La tabla siguiente define los atributos de los campos de Prompt. Solo son obligatorios los atributos messageKey y responseAttr.
Atributo | Tipo | Comportamiento por omisión | Sólo de lectura | Descripción |
---|---|---|---|---|
isChar | boolean | false | Sí | Indica si el primer carácter tecleado por el usuario se coloca o no en la
variable de respuesta. Si isChar = false, los caracteres tecleados por el usuario se colocan en la variable de respuesta. Si isChar = true, los caracteres tecleados por el usuario no se colocan en la variable de respuesta. |
message | string | false | No | Un valor de serie literal que se muestra al usuario durante una sentencia openUI (prompt). |
messageKey | Campo de consola | none | Sí | El valor de clave utilizado para buscar el mensaje en un paquete compuesto de recursos. Si se proporcionan messageKey y message, no se tiene en cuenta messageKey. |
response Attr | Campo de consola | none | Sí | Los atributos de presentación utilizados al aceptar la entrada del usuario. |