General Comunicator stuff

GeneralComunicator

Consejo

Utilícelo para recuperar datos generales.

Métodos

método	retorno	tipo	Descripción
refreshUI()	void	read	Refresca la interfaz de usuario.
getToolBarOption()	ToolBarOption	read	Recupera el objeto ToolbarOption. Las variables de ToolbarOption muestran las funcionalidades de OpenKM habilitadas o deshabilitadas por seguridad.
getLang()	String	read	Obtiene el código de idioma de la interfaz de usuario.
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.
downloadFile(String path, String params)	void	read	Descarga un archivo con parámetros. Método obsoleto en favor del método “downloadFileByUUID”.
downloadFileByUUID(String uuid, String params)	void	read	Descarga un archivo con parámetros. Parámetros permitidos: - El parámetro “checkout” marca el documento como “edición”. - El parámetro “inline” para descargar como adjunto, por ejemplo al descargar imágenes. - El parámetro “ver” para descargar una versión concreta del documento.
extensionCallOwnDownload(String url)	void	read	Se utiliza para llamar
resetStatus()	void	read	Restablece la barra de estado inferior derecha.
showError(String callback, Throwable caught)	void	read	Muestra una ventana emergente de error con algún mensaje.
logout()	void	read	Cierra la sesión en la interfaz de usuario de OpenKM.
refreshUserDocumentsSize()	void	read	Refresca el tamaño de los documentos del usuario.
getUserRoleList()	List	read	Recupera una lista con los roles del usuario.
getUser()	String	read	Recupera el userId.
i18nExtension(String property)	String	read	Recupera la traducción de la extensión.
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 solo la ruta de una carpeta, el parámetro “docPath” debe estar vacío.
getAppContext()	String	read	Recupera 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 true, indica que la extensión de firma digital está habilitada.
getDocumentToSign()	GWTDocument	read	Recupera un objeto documento que se va a firmar.
getWorkspace()	GWTWorkspace	read	Recupera el objeto GWT Workspace. El objeto contiene, entre otros, información sobre las funcionalidades de la interfaz (habilitadas o deshabilitadas).
i18n(String property)	String	read	Recupera la traducción del frontend.
enableKeyShorcuts()	void	read	Habilita los atajos de la interfaz.
disableKeyShorcuts()	void	void	Deshabilita los atajos de la interfaz.
openPathByUuid(String uuid)	void	void	Abre un nodo en openkm.
getFolderIcon(GWTFolder fld)	String	void	Recupera la ruta de la imagen del icono de la carpeta.
get()	Main	void	Recupera el objeto Main mediante el patrón singleton. La clase Main es la clase principal del frontend y ofrece acceso completo a cualquier método de la interfaz del frontend.
setStatus(String msg)	void	void	Cambia el mensaje de estado en la parte inferior derecha.

Ejemplo

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

NavigatorComunicator

Consejo

Utilícelo para recuperar datos del navegador.

Nota

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

Métodos

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

Ejemplo

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

FileBrowserComunicator

Consejo

Utilícelo para recuperar datos del explorador de archivos.

Métodos

método	retorno	tipo	Descripción
isDocumentSelected()	boolean	read	Cuando hay un documento seleccionado, devuelve el valor “true”.
isFolderSelected()	boolean	read	Cuando hay una carpeta seleccionada, devuelve el valor “true”.
isMailSelected()	boolean	read	Cuando hay un correo seleccionado, devuelve el valor “true”.
isRecordSelected()	boolean	read	Cuando hay un registro seleccionado, devuelve el valor “true”.
getDocument()	GWTDocument	read	Recupera un objeto documento GWT del documento seleccionado.
getFolder()	GWTFolder	read	Recupera un objeto carpeta GWT de la carpeta seleccionada.
getMail()	GWTMail	read	Recupera un objeto correo GWT del correo seleccionado.
getRecord()	GWTRecord	read	Recupera un objeto registro GWT del registro seleccionado.
isPanelSelected()	boolean	read	Cuando el panel del explorador de archivos está seleccionado, devuelve el valor “true”.
refreshOnlyFileBrowser()	void	read	Refresca únicamente la vista del widget del explorador de archivos.

Ejemplo

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

UtilComunicator

Consejo

Métodos de propósito general.

Métodos

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

Ejemplo

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

SearchComunicator

Consejo

Utilícelo para recuperar datos de búsqueda.

Métodos

método	retorno	tipo	Descripción
getAllSearchs()	void	read	Refresca el panel de búsquedas guardadas.
getUserSearchs()	void	read	Refresca el panel de búsquedas guardadas del usuario.
getSelectedRowSearchSaved()	int	read	Recupera la fila seleccionada del panel de búsquedas guardadas.
getSelectedRowUserNews()	int	read	Recupera la fila seleccionada del panel de búsquedas guardadas del usuario.
getSavedSearch()	GWTQueryParams	read	Recupera el objeto GWT QueryParams de la búsqueda guardada seleccionada.
getSavedUserNews()	GWTQueryParams	read	Recupera 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)	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 registros.
setSavedSearch(GWTQueryParams params)	void	write	Ejecuta una búsqueda guardada.

Ejemplo

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

ToolBarComunicator

Consejo

Utilícelo para recuperar datos de la barra de herramientas.

Métodos

método	retorno	tipo	Descripción
evaluateShowIcons()	void	read	Evalúa los iconos de la barra de herramientas según la seguridad.
getToolBarOption()	ToolBarOption	read	Recupera el objeto GWT ToolBarOption, que contiene información sobre las funcionalidades de la interfaz habilitadas o deshabilitadas.
getActualNode()	Object	read	Recupera el nodo seleccionado de la interfaz de usuario. El objeto recuperado puede convertirse a: - GWTDocument. - GWTFolder. - GWTMail. - GWTRecrod.
getMainToolBarPanel()	HorizontalPanel	read	Recupera el widget principal de la barra de herramientas.
setToolBarOption(ToolBarOption toolBarOption)	void	write	Cambia la opción de la barra de herramientas; habilita o deshabilita funcionalidades de la interfaz.

Ejemplo

ToolBarComunicator.evaluateShowIcons();