Este documento tiene como objetivo especificar la arquitectura y las consideraciones de diseño de la librería aFileDialog, a fin de servidor como referencia para los desarrolladores encargados de extender, actualizar o corregir la librería.
La especificación a sido desarrollada bajo el estándar IEEE 1016-2009, también conocido como "Standard for Information Technology - Systems Design - Software Design Descriptions", un estándar del IEEE que especifica la organización estructura de una descripción de diseño de software.
- GUI - Interfaz gráfica de usuario
- IEEE - Instituto de Ingenieros Eléctricos y Electrónicos
- MPL - Licencia pública de Mozilla
- SDD - Descripción de diseño de software
IEEE Computer Society. "IEEE Standard for Information Technology - System Design - Software Design Descriptions". 2009
El resto de este documento describe la arquitectura del sistema, la relación de los distintos módulos y las decisiones de diseño.
Se asume que el lector posee conocimientos básicos sobre programación orientada a objectos en Java y sobre el desarrollo de aplicaciones para Android.
aFileDialog es una librería que implementa un selector de archivos para el sistema operativo Android, el cual carece de un componente gráfico nativo que provea esta funcionalidad. La librería fue diseñada para ser fácil de utilizar y fácil de modificar y está licenciada como código abierto, bajo MPL v2.0, a fin de alentar su uso y mantenimiento.
Sus principales características son:
- El selector de archivos puede abrirse como una Dialog o como una Activity.
- Posee dos modos de selección, uno para seleccionar archivos y otro para seleccionar directorios.
- Permite crear el archivo o la carpeta que se desea seleccionar.
- Posibilita filtrar los archivos que pueden ser seleccionados mediante el uso de expresiones regulares.
- Provee soporte para múltiples idiomas (por defecto provee traducciones al español, al inglés y al francés, pero los desarrolladores puede definir el valor de los diferentes textos y etiquetas, a fin de internacionalizar el selector de archivos a otros idiomas).
- Está implementado íntegramente en Java y es compatible con Android 2.2 o superior.
Ninguna.
La librería deber ser implementada íntegramente en Java y debe ser compatible con Android 2.3 (como mínimo) y versiones posteriores.
El objetivo es desarrollar una librería que implemente un selector de archivos, para el sistema operativo Android, que sea fácil de utilizar y fácil de modificar, de acuerdo al principio de KISS (Keep it short and simple).
El método de desarrollo utilizado es el desarrollo incremental e iterativo, según el cual el software se desarrolla en varios ciclos, en cada uno de los cuales se agregan nuevas funcionalidades y se verifican y corrigen las funcionalidades agregadas en el ciclo anterior.
El software se estructuró haciendo uso de los patrones de diseños propios de la API de Android.
La librería está compuesta principalmente por seis archivos Java (FileChooser, FileChooserCore, FileChooserDialog, FileChooserActivity, FileChooserLabels y FileItem) y por dos archivos XML de layout (daidalos_file_chooser y daidalos_file_item):
- El núcleo de la librería está definido por la clase FileChooserCore, que implementa las principales funcionalidades, y el layout daidalos_file_chooser, que define la interfaz gráfica de los selectores de archivos.
- Las clases FileChooserDialog y FileChooserActivity se encargan principalmente de embeber las funcionalidades, implementadas en FileChooserCore, en, respectivamente, una Dialog y en una Activity. Esto lo realizan al implementar la interfaz FileChooser, la cual define los métodos callback que la clase FileChooserCore requiere para poder responder a los diferentes eventos de interfaz.
- La clase FileChooserLabels permite re-definir los valores de los textos y las etiquetas que son mostrados en los selectores de archivos, a fin de permitir internacionalizar la librería.
- La clase FileItem y la layout daidalos_file_item permiten definir un componente gráfico para representar a los archivos y los directorios, que serán listados en el selector de archivos.
Todas las funcionalidades del selector de archivos se encuentran implementadas en la clase FileChooserCore, la cual, en su constructor, requiere una instancia de la interfaz FileChooser.
FileChooser define los métodos que una subclase de View, que utilice el layout daidalos_file_chooser, debe implementar a fin de poder ser utilizada como un selector de archivos.
De esta forma se puede 'simular' la herencia múltiple (la cual no es soportada por Java): las clases FileChooserDialog y FileChooserActivity heredan, respectivamente, de las clases Dialog y Activity, y en sus constructores crean una instancia de FileChooserCore a fin 'heredar' también las funcionalidades implementadas por esta clase.
La interfaz gráfica está definida por los archivos XML de layout daidalos_file_chooser y daidalos_file_item.
daidalos_file_chooser define la interfaz de los selectores de archivos, la cual se compone de un layout vertical, que ocupa todo el alto y ancho de la pantalla y en el que se ubican los archivos y directorios que se pueden seleccionar, y de dos botones en la parte inferior, uno para crear archivos o directorios y otros para seleccionar el directorio actual (en el caso de que se esté en el modo de selección de directorios).
daidalos_file_item define la interfaz del componete gráfico utilizado para representar a los archivos y carpetas que se listan en el layout vertical de los selectores de archivos. Este compnente se compone de un ícono (que permite diferenciar los archivos de las carpetas) y de un label (con el nombre del archivo).
El layout daidalos_file_chooser es utilizado por las clases FileChooserDialog y FileChooserActivity, que actúan de intermediarios entre el layout y la clase FileChooserCore, mientras que el layout daidalos_file_item es utilizado por la clase FileItem, la cual es una subclase LinearLayout que define un componente gráfico para representar archivos y directorios.
Todas las etiquetas y mensajes mostrados por las diferentes clases e interfaces se encuentran definidos en archivos string.xml, haciendo uso de los mecanismos de internacionalización provistos por la SDK de Android.
Por defecto, solo los idiomas inglés, francés y español están soportados, sin embargo, los desarrolladores pueden agregar nuevos idiomas (o modificar los existentes) haciendo uso de la clase FileChooserLabels.
En cada intancia de la clase FileChooserLabels se puede re-definir el valor de los textos y etiquetas. Esta instancia luego debe ser pasada a la clase FileChooserCore, a fin de que esta utilice los valores de dicha instancia, en vez de los valores definidos en string.xml.