API JavaScript del frontend expuesta

Funciones generales

Función	Retorno	Descripción	Obsoleta
jsI18n(String)	void	Obtiene una traducción del frontend. El parámetro es la clave de traducción.	no
jsOpenUserTaskInstance(String)	void	Abre el flujo de trabajo del panel de control para ver una tarea de usuario. El parámetro es el id de la instancia de la tarea.	no
jsOpenPath(String, String)	void	Abre un nodo en la interfaz de usuario de OpenKM. El primer parámetro es la ruta de la carpeta. El segundo parámetro es la ruta del documento. Cuando el parámetro de la ruta del documento está vacío, se abrirá una carpeta.	no
jsOpenPathByUuid(String)	void	Abre un nodo en la interfaz de usuario de OpenKM. El parámetro es un UUID de nodo válido (documento, carpeta, correo o expediente).	no
jsRefreshFolder()	void	Actualiza la interfaz de usuario (como la acción del botón de actualizar de la barra de herramientas).	no
jsWizard(String, String)	void	Ejecuta el asistente. El primer parámetro es la ruta de un documento. El segundo parámetro es una serialización JSON en forma de cadena de un bean GWTFileUploadResponse. Normalmente, el asistente debe llamarse después de subir un documento.	no
i18n(String)	void	Obtiene una traducción del frontend. El parámetro es la clave de traducción.	sí
openPath(String, String)	void	Abre un nodo en la interfaz de usuario de OpenKM. El primer parámetro es la ruta de la carpeta. El segundo parámetro es la ruta del documento. Cuando el parámetro de la ruta del documento está vacío, se abrirá una carpeta.	sí
openPathByUuid(String)	void	Abre un nodo en la interfaz de usuario de OpenKM. El parámetro es un UUID de nodo válido (documento, carpeta, correo o expediente).	sí
refreshFolder()	void	Actualiza la interfaz de usuario (como la acción del botón de actualizar de la barra de herramientas).	sí
jsCancelCheckout()	void	Cancela el checkout del documento seleccionado en la interfaz de usuario.	no
jsGetActualPath()	String	Devuelve la ruta del nodo del árbol seleccionado en el navegador.	no
jsGetActualNodePath()	String	Devuelve la ruta del nodo seleccionado en el navegador o en el explorador de ficheros.	no
jsGetActualNodeUUID()	String	Devuelve el UUID del nodo seleccionado en el navegador o en el explorador de ficheros.	no
jsGetUser()	String	Devuelve el objeto GWTUser serializado a JSON.	no
jsDownloadByUuid(String)	void	Descarga un documento. El parámetro es el UUID del documento.	no
jsChangeSelectedTab(int)	void	Cambia la pestaña del espacio de trabajo. Valores permitidos: - 0 para Desktop. - 1 para Search. - 2 para Dashboard. - 3 para Administration.	no

Funciones de criptografía

Función	Retorno	Descripción	Obsoleta
cryptographyLoaded()	void	Oculta la ventana emergente de estado de la interfaz de usuario que indica que el applet de criptografía aún no se ha cargado.	no
digitalSignatureEnded()	void	Indica que la firma digital ha finalizado.	no
digitalSignatureCanceled()	void	La firma digital se ha cancelado.	no
startDigitalSignature()	void	Inicia la firma digital.	no

Funciones de applet

Función	Retorno	Descripción	Obsoleta
destroyScannerApplet()	void	Limpia el applet del escáner.	no
destroyUploaderApplet()	void	Limpia el applet de subida masiva.	no

Funciones del editor HTML

Función	Retorno	Descripción	Obsoleta
jsSearchDocumentHTMLEditorPopup()	void	Muestra la ventana emergente de búsqueda de documentos.	no
jsSearchFolderHTMLEditorPopup()	void	Muestra la ventana emergente de búsqueda de carpetas.	no

Funciones de wiki

Función	Retorno	Descripción	Obsoleta
jsOpenWikiPage(String)	void	Abre una página de wiki. El parámetro es el título único de la wiki.	no
openWikiPage(String)	void	Abre una página de wiki. El parámetro es el título único de la wiki.	sí

Cómo exponer métodos Java a JavaScript

Ejemplo de método estático

Exponga el método estático llamado i18n(String property) a JavaScript como la función “jsI18n(String)”:

/**
 * initJavaScriptApi
 */
native void initJavaScriptApi() /*-{
  $wnd.jsI18n = function(s) {
    return @com.openkm.frontend.client.Main::i18n(Ljava/lang/String;)(s);
  };
}-*/;

Ejemplo de método no estático

Exponga el método no estático “executeRefresh()” de la clase Toolbar.java a JavaScript como la función jsRefreshFolder:

En la clase Java Toolbar, cree un método llamado “initJavaScriptApi()”:

public native void initJavaScriptApi(ToolBar toolBar) /*-{
  $wnd.jsRefreshFolder = function() {
    toolBar.@com.openkm.frontend.client.widget.toolbar.ToolBar::executeRefresh()();
    return true;
  }
}-*/;

Tras crear un nuevo objeto Toolbar, llame al método “initJavaScriptApi()”:

ToolBar toolBar = new ToolBar();
mainPanel.topPanel.toolBar.initJavaScriptApi(mainPanel.topPanel.toolBar);

Ejemplo de integración

Cree un fichero “sample.jsp”:

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<html>
  <head>
    <title>Sample test</title>
    <script>
      function refresh() {
        alert('executing refresh');
        parent.parent.refreshFolder();
        alert('done');
      }
    </script>
  </head>
  <body>
    <a href="#" onclick="refresh()">Refresh UI</a>
  </body>
</html>

Copie el fichero “sample.jsp” en su carpeta “$TOMCAT_HOME/webapps/openkm/”.

Habilite la extensión llamada “External Tab Document”; consulte Habilitar extensiones y Extensión de pestaña externa de documento. Recuerde que debe habilitar la extensión desde los Perfiles.

Configure el parámetro extension.external.tab.document con el valor siguiente.

Campo / Propiedad	Tipo	Descripción
extension.external.tab.document	List	Cada fila es un par de valores con la declaración del contenido de una pestaña; el formato es: nombre;url Sample;http://localhost:8180/openkm/test.jsp