VTabWidget

Hereda de: Widget.

Esta clase representa al control separador de subformularios.

Indice de propiedades

const Number count

Number currentIndex

Boolean documentMode

Number elideMode

const Number iconSize

Boolean movable

Number tabPosition

Boolean tabsClosable

Boolean usesScrollButtons

Indice de funciones

Generales

VFormDataView addForm( String szIdRefForm, String szText, [VImage imagen] )

Number findForm( String szIdRefForm )

Number findForm( Widget form )

VFormDataView form( Number index )

VFormDataView form( String szIdRefForm )

VFormDataView insertForm( Number index, String szIdRefForm, String szText, [VImage imagen] )

Boolean isFormEnabled( Number index )

void removeForm( Number index )

void setCurrentIndex( Number index )

void setCurrentWidget( Widget form )

void setFormEnabled( Number index, Boolean enabled )

De pestañas

String labelText( Number index )

void setIcon( Number index, VImage imagen)

void setLabelText( Number index, String szLabel )

void setToolTip( Number index, String szTip )

void setWhatsThis( Number index, String szText )

String toolTip( Number index )

String whatsThis( Number index )

Señales

Item: cambio de seleccionado

Documentación de propiedades

count

Devuelve el número de pestañas/subformularios.

currentIndex

Devuelve el índice de la pestaña/subformulario en curso.

documentMode

Permite leer o configurar si el widget se representa en un modo adecuado para visualizar las páginas del documento. Este es el mismo modo de documento que en Mac OS X. Cuando esta propiedad se establece a true el marco del widget no se representa. Este modo es útil para mostrar las páginas de un documento en el que la página cubre la mayor parte del área de widget.

elideMode

Permite leer o configurar la forma en que se contrae el texto en la barra de pestañas. Esta propiedad controla el número de elementos a contraer cuando no hay espacio suficiente para mostrar todas las pestañas. Por defecto, el valor es dependiente de estilo.

Los valores posibles son:

• ElideNone: no aparecerá elipsis en el texto. Ejemplo: "Observaciones".

• ElideLeft: la elipsis aparecerá al comienzo del texto. Ejemplo: "...ones".

• ElideMiddle: la elipsis aparecerá en la mitad del texto. Ejemplo: "O...s".

• ElideRight: la elipsis aparecerá al final del texto.

  Ejemplo: "Obs...".

iconSize

Devuelve el tamaño de los iconos en la barra de pestañas. El valor por defecto depende del estilo. Este es el tamaño máximo que los iconos tienen. Los iconos no se amplían si son de un tamaño menor.

movable

Permite leer o configurar si el usuario puede mover las fichas en el área de barra de pestañas. De forma predeterminada, esta propiedad es false.

tabPosition

Permite leer o configurar la posición de las pestañas. Los valores posibles para esta propiedad son descritos por el TabPosition enum. De forma predeterminada, esta propiedad se establece al Norte.

Enum TabPosition:

0 - North

1 - South

2 - West

3 - East

tabsClosable

Permite leer o configurar si cada pestaña tendrá un botón de cierre.

usesScrollButtons

Permite leer o configurar si se mostrará un control con botones de desplazamiento cuando existan muchas pestañas. Cuando hay demasiadas pestañas en la barra de pestañas para su tamaño, la barra de pestañas o bien puede optar por ampliar su tamaño o agregar botones que le permiten desplazarse por las fichas.

Por defecto, el valor es dependiente de estilo.

Documentación de funciones

Funciones generales

VFormDataView addForm( String szIdRefForm, String szText, [VImage imagen] )

Añade una nueva pestaña con un subformulario.

Parámetros:

• szIdRefForm: identificador de referencia, alias_proyecto/identificador_formulario, del formulario.

• szText: texto que se mostrará en la pestaña.

• imagen: opcional. Objeto de la clase VImage que contiene el icono a mostrar en la pestaña.

Number findForm( String szIdRefForm )

Devuelve el índice correspondiente a la posición ocupada por el formulario con el idRef especificado.

Parámetros:

• szIdRefForm: identificador de referencia, alias_proyecto/identificador_formulario, del formulario.

Number findForm( Widget form )

Devuelve el índice correspondiente a la posición ocupada por el formulario del widget especificado.

Parámetros:

• form: objeto de la clase Widget que se corresponde con el subformulario.

VFormDataView form( Number index )

Devuelve el subformulario correspondiente al índice.

Parámetros:

• index: número correspondiente a la posición que ocupa el subformulario que se desea obtener.

VFormDataView form( String szIdRefForm )

Devuelve el subformulario correspondiente al formulario con el idRef especificado.

Parámetros:

• szIdRefForm: identificador de referencia, alias_proyecto/identificador_formulario, del formulario.

VFormDataView insertForm( Number index, String szIdRefForm, String szText, [VImage imagen] )

Inserta un subformulario correspondiente al formulario con el IdRef especificado en la posición del índice.

Parámetros:

• index: número correspondiente a la posición en la que se desea insertar el subformulario.

• szIdRefForm: identificador de referencia, alias_proyecto/identificador_formulario, del formulario.

• szText: texto que se mostrará en la pestaña.

• imagen: opcional. Objeto de la clase VImage que contiene el icono a mostrar en la pestaña.

Boolean isFormEnabled( Number index )

Devuelve true si la pestaña está activa.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

void removeForm( Number index )

Elimina el subformulario correspondiente al índice.

Parámetros:

• index: número correspondiente a la posición que ocupa el subformulario que se desea eliminar.

void setCurrentIndex( Number index )

Convierte a subformulario en curso al especificado en el índice.

Parámetros:

• index: número correspondiente a la posición que ocupa el subformulario que se desea asignar como subformulario en curso.

void setCurrentWidget( Widget form )

Convierte a Widget en curso el objeto formulario especificado.

Parámetros:

• form: objeto de la clase Widget que se corresponde con el subformulario.

void setFormEnabled( Number index, Boolean enabled )

Fija si la pestaña estará activada o desactivada.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

• enable: valor booleano. True=La pestaña se activa. False=La pestaña se desactiva.

Funciones de pestañas

String labelText( Number index )

Devuelve el texto de la pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

void setIcon( Number index, VImage imagen)

Asigna el icono a mostrar en una pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

• imagen: opcional. Objeto de la clase VImage que contiene el icono a mostrar en la pestaña.

void setLabelText( Number index, String szLabel )

Asigna el texto a mostrar en una pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

• szLabel: texto a mostrar en la pestaña.

void setToolTip( Number index, String szTip )

Asigna el texto a mostrar en el tooltip de una pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

• szTip: texto a mostrar en el tooltip de la pestaña.

void setWhatsThis( Number index, String szText )

Asigna el texto de ayuda ¿Qué es esto? para una pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

• szText: texto a mostrar en la ayuda ¿Qué es esto? de la pestaña.

String toolTip( Number index )

Devuelve el texto a mostrar en el tooltip de la pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

String whatsThis( Number index )

Devuelve el texto de ayuda ¿Qué es esto? de una pestaña.

Parámetros:

• index: número correspondiente a la posición que ocupa la pestaña.

Ejemplos

1. Contraer el texto de las pestañas haciendo elipsis por la derecha

//Obtenemos el control separador
var separador = theRoot.dataView().control("SEP");

//Aplicamos la elipsis por la derecha
separador.elideMode = "ElideRight";

2. Añadir un subformulario a un separador desde un evento del formulario principal

// Obtenemos el formulario principal.
formulario = theRoot.dataView().mainForm();

// Identificamos el separador con el identificador que éste tiene dentro del formulario principal.

separador = formulario.control( "SEP" );

// Usamos la función addForm para añadir el formulario del separador.

separador.removeForm( tab );

cur.addForm("miproyecto/ID_FORMULARIO","Título pestaña");

3. Quitar un subformulario de un separador desde un evento del formulario principal

// Obtenemos el formulario principal.
formulario = theRoot.dataView().mainForm();

// Identificamos el separador con el identificador que éste tiene dentro del formulario principal.

separador = formulario.control( "SEP" );

/* Identificamos el subformulario a quitar del separador. Para ello debemos especificar
su identificador precedido del proyecto al que pertenece*/

var tab = separador.findForm( "velneo_verp_bas_app/COM_PED_PRN" );

// Usamos la función removeForm para quitar el formulario del separador.

separador.removeForm( tab );