General Comunicator stuff

General Communicator

Consejo

Úselo para obtener datos generales.

Métodos

Método	Devuelve	Tipo	Descripción
refreshUI()	void	read	Actualiza la interfaz de usuario.
getToolBarOption()	ToolBarOption	read	Obtiene el objeto ToolbarOption. Las variables de ToolbarOption indican qué funcionalidades de OpenKM están habilitadas o deshabilitadas por seguridad.
getLang()	String	read	Obtiene el código del idioma de la interfaz de usuario.
i18nExtension(String property)	String	read	Obtiene la traducción de una extensión.
i18n(String property)	String	read	Obtiene la traducción del frontend.
downloadDocument(boolean checkout)	void	read	Descarga el documento seleccionado. Cuando el valor de checkout es “true”, el documento se marcará como “edición”.
downloadDocumentPdf()	void	read	Descarga el documento seleccionado como PDF.
extensionCallOwnDownload(String url)	void	read	Se utiliza para llamar a
downloadFileByUUID(String uuid, String params)	void	read	Descarga un fichero con parámetros. Parámetros permitidos: - El parámetro “checkout” marca el documento como “edición”. - El parámetro “inline” descarga como adjunto, por ejemplo para descargar imágenes. - El parámetro “ver” descarga una versión concreta del documento.
downloadFile(String path, String params)	void	read	Descarga un fichero con parámetros. Obsoleto en favor del método “downloadFileByUUID”.
setStatus(String msg)	void	void	Cambia el mensaje de estado de la parte inferior derecha.
resetStatus()	void	read	Restablece la barra de estado de la parte inferior derecha.
showError(String callback, Throwable caught)	void	read	Muestra una ventana emergente de error con un mensaje.
logout()	void	read	Cierra la sesión de la interfaz de usuario de OpenKM.
getUserRoleList()	List	read	Obtiene una lista de los roles del usuario.
getUser()	String	read	Obtiene el identificador del usuario.
openPath(String path, String docPath)	void	read	Abre un nodo en OpenKM. Parámetros: - El parámetro “path” debe ser una “ruta de carpeta” válida. - El parámetro “docPath” debe estar vacío o ser una “ruta de documento” válida. Para abrir la ruta de una sola carpeta, el parámetro “docPath” debe estar vacío.
openAllFolderPath(String path, String docPath)	void	read	Abre todas las carpetas en OpenKM. Parámetros: - El parámetro “path” debe ser una “ruta de carpeta” válida. - El parámetro “docPath” debe estar vacío o ser una “ruta de documento” válida. Para abrir la ruta de una sola carpeta, el parámetro “docPath” debe estar vacío.
getAppContext()	String	read	Obtiene el contexto de la aplicación.
showNextWizard()	void	read	Muestra el siguiente asistente. Los asistentes se muestran después de subir un documento.
isDigitalSignature()	boolean	read	Cuando es verdadero, indica que la extensión de firma digital está habilitada.
getDocumentToSign()	GWTDocument	read	Obtiene un objeto de documento para firmar.
getSessionId()	String	read	Obtiene una sesión.
getWorkspace()	GWTWorkspace	read	Obtiene el objeto GWT Workspace. El objeto contiene información sobre las funcionalidades de la interfaz de usuario (habilitadas o deshabilitadas), entre otras.
enableKeyShortcuts()	void	read	Habilita los atajos de teclado de la interfaz de usuario.
disableKeyShortcuts()	void	void	Deshabilita los atajos de teclado de la interfaz de usuario.
openPathByUuid(String uuid)	void	void	Abre un nodo en OpenKM.
getFolderIcon(GWTFolder fld)	String	void	Obtiene la ruta de la imagen del icono de la carpeta.
get()	Main	void	Obtiene el objeto Main a partir del patrón singleton. La clase Main es la clase principal del frontend y ofrece acceso completo a cualquier método de la interfaz de usuario del frontend.

Ejemplo

// Call to refreshing user interface
GeneralComunicator.refreshUI();

DashboardCommunicator

Consejo

Úselo para obtener los datos de la pestaña del panel de control.

Métodos

Método	Devuelve	Tipo	Descripción
getUserSubscribedDocuments()	void	read	Actualiza la lista de documentos a los que el usuario está suscrito.
getUserSubscribedFolders()	void	read	Actualiza la lista de carpetas a las que el usuario está suscrito.
refreshAllSearches()	void	read	Actualiza la lista de búsquedas.
showToolBoxExtension(ToolBarBoxExtension extension)	void	read	Cambia el botón seleccionado del panel de control.
getUserSearches(boolean refresh)	void	read	Actualiza la lista de búsquedas del usuario. Cuando el valor booleano refresh es verdadero, también actualiza los resultados de las búsquedas en la vista de novedades del panel de control.
isWidgetExtensionVisible(Widget widget)	boolean	read	Cuando es verdadero, indica que la extensión del widget está habilitada.

Ejemplo

// Call to refreshing subscribed documents
DashboardComunicator.getUserSubscribedDocuments();

FileBrowserCommunicator

Consejo

Úselo para obtener los datos del explorador de ficheros.

Métodos

Método	Devuelve	Tipo	Descripción
isDocumentSelected()	boolean	read	Cuando hay un documento seleccionado, devuelve “true”.
isFolderSelected()	boolean	read	Cuando hay una carpeta seleccionada, devuelve “true”.
isMailSelected()	boolean	read	Cuando hay un correo seleccionado, devuelve “true”.
isRecordSelected()	boolean	read	Cuando hay un expediente seleccionado, devuelve “true”.
getDocument()	GWTDocument	read	Obtiene un objeto GWT de documento del documento seleccionado.
getFolder()	GWTFolder	read	Obtiene un objeto GWT de carpeta de la carpeta seleccionada.
getMail()	GWTMail	read	Obtiene un objeto GWT de correo del correo seleccionado.
getRecord()	GWTRecord	read	Obtiene un objeto GWT de expediente del expediente seleccionado.
isPanelSelected()	boolean	read	Cuando el panel del explorador de ficheros está seleccionado, devuelve “true”.
refreshOnlyFileBrowser()	void	read	Actualiza únicamente la vista del widget del explorador de ficheros.
isMassive()	boolean	read	Cuando es verdadero, indica que el modo masivo está habilitado.
getAllSelectedUUIDs()	List	read	Obtiene una lista de los UUID seleccionados.

Ejemplo

 if (FileBrowserComunicator.isDocumentSelected()) {
     Window.alert("document selected");
 } else {
     Window.alert("document not selected");
 }

NavigatorCommunicator

Consejo

Úselo para obtener los datos del navegador.

Nota

El panel del navegador contiene un panel apilado con árboles de carpetas (taxonomía, categorías, etc.).

Métodos

Método	Devuelve	Tipo	Descripción
getStackIndex()	int	read	Obtiene el identificador del índice de la pila.
isTaxonomyShown()	boolean	read	Cuando es verdadero, indica que la pila de taxonomía se muestra.
isCategoriesShown()	boolean	read	Cuando es verdadero, indica que la pila de categorías se muestra.
isMetadataShown()	boolean	read	Cuando es verdadero, indica que la pila de metadatos se muestra.
isThesaurusShown()	boolean	read	Cuando es verdadero, indica que la pila de tesauro se muestra.
isTemplatesShown()	boolean	read	Cuando es verdadero, indica que la pila de plantillas se muestra.
isPersonalShown()	boolean	read	Cuando es verdadero, indica que la pila personal se muestra.
isMailShown()	boolean	read	Cuando es verdadero, indica que la pila de correo se muestra.
isTrashShown()	boolean	read	Cuando es verdadero, indica que la pila de la papelera se muestra.
getFolder()	GWTFolder	read	Obtiene el objeto de la carpeta seleccionada de la vista de árbol habilitada. Le recomendamos utilizar el método getNode() en lugar de este.
getActualPath()	String	read	Obtiene la ruta de la carpeta seleccionada de la vista de árbol habilitada.
getRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:root”.
getCategoriesRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:categories”.
getMetadataRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:metadata”.
getThesaurusRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:thesaurus”.
getTemplatesRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:templates”.
getPersonalRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:personal”.
getMailRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:mail”.
getTrashRootFolder()	GWTFolder	read	Obtiene el objeto GWT de carpeta del nodo “/okm:trash”.
isPanelSelected()	boolean	read	Cuando es “true”, indica que el panel del navegador es el nodo seleccionado.
getNode()	GWTNode	read	Obtiene el objeto del nodo seleccionado de la vista de árbol habilitada. El nodo seleccionado puede ser una carpeta o un expediente.

Ejemplo

int stack = NavigatorComunicator.getStackIndex();
if (stack==0) {
  Window.alert("First stack enabled");
} else {
  Window.alert("Other stack");
}

SearchCommunicator

Consejo

Úselo para obtener los datos de búsqueda.

Métodos

Método	Devuelve	Tipo	Descripción
setSavedSearch(GWTQueryParams params)	void	write	Ejecuta una búsqueda guardada.
getAllSearches()	void	read	Actualiza el panel de búsquedas guardadas.
getUserSearches()	void	read	Actualiza el panel de búsquedas guardadas del usuario.
getSelectedRowSearchSaved()	int	read	Obtiene la fila seleccionada del panel de búsquedas guardadas.
getSelectedRowUserNews()	int	read	Obtiene la fila seleccionada del panel de búsquedas guardadas del usuario.
getSavedSearch()	GWTQueryParams	read	Obtiene el objeto GWT QueryParams de la búsqueda guardada seleccionada.
getSavedUserNews()	GWTQueryParams	read	Obtiene el objeto GWT QueryParams de la búsqueda guardada del usuario seleccionada.
showFolderSelectPopup(FindFolderHandler findFolderHandler)	void	read	Registra un manejador para la ventana emergente de búsqueda de carpetas.
showDocumentSelectPopup(FindDocumentHandler findDocumentHandler, int typeSearch)	void	read	Registra un manejador para la ventana emergente de búsqueda de documentos.
showMailSelectPopup(FindMailHandler findMailHandler)	void	read	Registra un manejador para la ventana emergente de búsqueda de correos.
showRecordSelectPopup(FindRecordHandler findRecordHandler)	void	read	Registra un manejador para la ventana emergente de búsqueda de expedientes.

Ejemplo

// Call to refreshing subscribed documents
GWTQueryParams params = new GWTQueryParams();
params.setName("test");
SearchComunicator.setSavedSearch(params);

UtilCommunicator

Consejo

Métodos de propósito general.

Métodos

Método	Devuelve	Tipo	Descripción
formatSize(double size)	String	read	Convierte el tamaño de un documento en bytes a un valor legible (KB, MB, GB, etc.).
createHeaderHTML(String imageURL, String caption)	String	read	Obtiene el código HTML de una cabecera de pila para utilizarlo en un widget de pila del frontend GWT.
imageItemHTML(String imageUrl, String title, String align)	String	read	Obtiene el código HTML de una imagen para utilizarlo en un widget del frontend GWT.
menuHTML(String imageUrl, String text)	String	read	Obtiene el código HTML de un menú para utilizarlo en un elemento de menú del frontend GWT.
menuHTMLWithoutIcon(String text)	String	read	Obtiene el código HTML de un menú para utilizarlo en un elemento de menú del frontend GWT.
imageItemHTML(String imageUrl)	String	read	Obtiene el código HTML de una imagen para utilizarlo en un widget del frontend GWT.
getTextAsBoldHTML(String text, boolean mark)	String	read	Obtiene el texto como HTML en negrita.
getUserAgent()	String	read	Obtiene el agente de usuario del navegador.
getName(String path)	String	read	Obtiene el nombre de una ruta. El nombre de “/okm:root/temp/doc1.pdf” es “doc1.pdf”.
getParent(String path)	String	read	Obtiene la ruta padre de una ruta. El padre de “/okm:root/temp/doc1.pdf” es “/okm:root/temp”.
mimeImageHTML(String mime)	String	read	Obtiene la URL del icono del tipo MIME.
hSpace(String width)	HTML	read	Obtiene un separador horizontal HTML de GWT.
vSpace(String height)	HTML	read	Obtiene un separador vertical HTML de GWT.
isSearchableKey(KeyUpEvent event)	boolean	read	Evalúa si la tecla pulsada no es una tecla de navegación, de flecha o modificadora. Teclas de navegación: HOME, END, PAGEUP, PAGEDOWN. Teclas modificadoras: SHIFT, ALT, CTRL, DOWN. Teclas de flecha: LEFT, RIGHT, UP, DOWN.

Ejemplo

// Call to formatting the document size ( gb, mb etc... )
UtilComunicator.formatSize(15);