VCWebView

Hereda de: Widget.

Esta clase representa al control visor HTML y navegador web.

Con la función setLinkDelegationPolicy le decimos al navegador como queremos que gestione los link pulsados:

DontDelegateLinks: en este modo el navegador gestiona todos los enlaces

DelegateExternalLinks: en este modo el navegador gestiona los enlaces internos (del sistema de ficheros local) y emite la señal LinkClicked(url) para los externos.

DelegateAllLinks: en este modo emite la señal LinkClicked(url) para todos los enlaces.

El modo por defecto es DontDelegateLinks. Si el navegador gestiona un enlace emite la señal LoadStarted y si no emite la señal LinkClicked(url), en cuyo caso hay que cargar la página en el manejador del evento o realizar la acciones que consideremos oportunas.

El valor del enlace activado (url) se puede leer en el valor 1 de la variable tipo array EVENT_PARAMS.

Indice de funciones

Generales

Number linkDelegationPolicy()

String selectedText()

void setLinkDelegationPolicy( Number deleg )

void setSourceCode( String html, [String urlBase])

void setZoomFactor( Number factor )

String sourceCode()

String title()

String url()

Number zoomFactor()

De operaciones

void back()

void forward()

void load( String url )

void print( String printerName, Boolean bHighResolution )

void printToPdf( String szFileName )

void reload()

void stop()

De toolbar

void hideToolBar()

Boolean isToolBarVisible()

void showToolBar()

Señales

LinkClicked( String url )

LoadFinished( Boolean ok )

LoadProgress( Number porcentaje )

LoadStarted

UrlChanged( String url )

Enumeraciones

Link delegation policy

• DontDelegateLinks = 0 (en este modo el navegador gestiona todos los enlaces, es el valor por defecto).

• DelegateExternalLinks = 1 (en este modo el navegador gestiona los enlaces internos -del sistema de ficheros local- y emite la señal LinkClicked(url) para los externos).

• DelegateAllLinks = 2 (en este modo emite la señal LinkClicked(url) para todos los enlaces).

Documentación de funciones

Funciones generales

Number linkDelegationPolicy()

Devuelve el valor de delegación que tiene asignado el control. El valor será uno de los existentes en la enumeración de link delegation policy.

String selectedText()

Devuelve el texto seleccionado en la página.

void setLinkDelegationPolicy( Number deleg )

Fija el comportamiento de los enlaces de la página web al ser pulsados.

Parámetros:

• deleg: valor del enum link delegation policy. Ver descripción de la clase para una información ampliada sobre los valores de este enum.

El valor del enlace activado se puede recoger en la aplicación leyendo el valor 1 de la variable tipo array EVENT_PARAMS.

void setSourceCode( String html, [String urlBase])

Fija el código fuente HTML a visualizar en el control.

Parámetros:

• html: cadena de texto con el código HTML a visualizar en el control.

• urlBase: senda del directorio base para las sendas relativas especificadas en el HTML.

void setZoomFactor( Number factor )

Establece el factor de zoom.

Parámetros:

• factor: number que contiene el factor de zoom.

String sourceCode()

Devuelve el código fuente de la página en curso.

String title()

Devuelve el título de la página.

String url()

Devuelve la url de la página.

Number zoomFactor()

Devuelve el factor de zoom.

Funciones de operaciones

void back()

Vuelve a la página anterior del historial de navegación.

void forward()

Va a la página siguiente del historial del navegador.

void load( String url )

Carga la página.

Parámetros:

• url: string que contiene la url de la página.

void print( String printerName, Boolean bHighResolution )

Imprime la página en curso.

Parámetros:

• printerName: cadena que contiene el nombre de la impresora.

• bHighResolution: booleano que configura si se imprime con alta resolución (true) o baja resolución (false).

void printToPdf( String szFileName )

Guarda en pdf la página en curso.

Parámetros:

• szFileName: cadena que contiene la senda completa del archivo pdf a generar.

void reload()

Recargar la página en curso.

void stop()

Detiene la carga de la página.

Funciones de toolbar

void hideToolBar()

Oculta la toolbar del control visor HTML.

Boolean isToolBarVisible()

Devuelve true si la toolbar del control visor HTML está visible.

void showToolBar()

Muestra la toolbar del control visor HTML.

Ejemplo

Configurar un visor html para poder atrapar los enlaces pulsados dentro del mismo

Para que podamos gestionar los enlaces que se sigan en las páginas que se carguen en un visor html, es necesario ejecutaren el evento de post-inicializado del formulario un manejador de evento JavaScript con un código similar al siguiente:

// Atrapamos todos los clics en enlaces del control visor html
menu = theRoot.dataView().control( "ID_CONTROL" );
menu.setLinkDelegationPolicy( VCWebView.DelegateAllLinks );