Documentación de las clases del submódulo de la PrácticaOOP usando documentation.js.
Table of Contents
GenericTextCell
Clase celda genérica usada para herencia *
Parameters
-
text
string Variable "text" que contiene el valor almacenado en la celda.
draw
Método usado para "dibujar" la celda al completo. Al ser genérica la celda solo contendrá y mostrará sus valores contenidos.
Parameters
Returns string text Celda con el texto con el formato decidido.
getContent
Devuelve el contenido de la celda. Se almacena en un vector llamado "result" que será lo que devuelva el método". Dicho vector se rellena con todos los elementos de "text" concatenados con tantos espacios como sean necesarios para alcanzar el tamaño elegido para la celda.
Parameters
Returns string text Celda con el texto con el formato decidido.
minWidth
Devuelve la anchura mínima necesaria para la celda. Se elige entre:
- Un valor "width" establecido para la celda.
- El tamaño de alguna palabra que supere el valor "width" en caso de que existe.
Returns number Width Ancho mínimo.
minHeight
Devuelve la altura de la celda. Para ello se basa en la cantidad de elementos almacenados en "text" y le asigna una fila de altura por cada una.
Returns number Height Alto mínimo.
RightCell
Extends GenericTextCell
Celda hija de la celda genérica que tiene sus elementos *
Parameters
text
draw
El contenido de la celda se imprime igual que con el "draw -> getContent" del padre pero alineado a la derecha.
Parameters
Returns string text Contenido de la celda alineado a la derecha.
StretchCell
Celda hija que añade una trazo vacío bajo los elementos de la misma *
Parameters
minWidth
Método que devuelve el ancho mínimo para la celda.
Returns number Width Ancho mínimo.
minHeight
Método que devuelve el alto mínimo para la celda.
Returns number Height Alto mínimo.
draw
Método que dibuja la celda.
Parameters
Returns string text Celda.
getContent
Devuelve el contenido de la celda.
Parameters
Returns string text Contenido de la celda.
Tabla
Clase para crear la tabla que contendrá el fichero de entrada *
drawAllTable
Método que llama a "drawTable" para dibujar la tabla con su contenido
Parameters
data
-
input
string Información de entrada para crear la tabla.
drawTable
Método para dibujar la tabla. Proceso: Se obtienen todas las filas necesarias para cada una de las celdas de las que se compone la tabla. Se obtienen todos los espacios necesarios para representar el ancho de cada una de las celdas que componen las columnas de la tabla. Se define una función que a través de un map dibuja todos los elementos de una fila separados por espacios. Se define una función que dibuja las celdas de las filas de la tabla y el contenido de las mismas. Al ser invocado en el return del final del método, usando un map, llama al método por cada fila pasándola la misma y el índice de esta. Se llama al map que invoca a la función "drawRow" y a su vez a la "drawLine" por cada fila.
Parameters
-
rows
Object Las filas de la tabla (contenido).
Returns string text La tabla dibujada a base de texto.
dataTable
Método que extrae los datos de la tabla y los monta en una estructura formada por la cabecera (headers) y el cuerpo (body). Para la cabecera obtiene los "key-tags" de la primera fila del fichero leido y crea celdas underlined con ellas. Para el cuerpo recorre todo el fichero y con los números crea celdas alineadas a la derecha (con fines estéticos) mientras que el resto se añaden en celdas normales.
Parameters
-
data
Object Input con la información para la tabla.
Returns Object cells Estructura de la tabla montada con celdas.
rowHeights
Método que devuelve el alto necesario para las filas de la tabla (altura). Se elige por cada fila entre un "max" determinado o el mínimo necesario para representar los elementos de dichas filas.
Parameters
-
rows
Object Filas.
Returns number rowHeights Alto necesario.
colWidths
Método que devuelve el ancho necesario para cada una de las columnas de la tabla. Se obtienen eligiendo entre un valor "max" o el ancho mínimo necesario para representar los valores de cada una de dichas columnas.
Parameters
-
rows
Object Filas.
Returns number colWidths Ancho necesario.
UnderlinedCell
Extends GenericTextCell
Celda hija que hereda de la celda genérica pero que incluye una fila de "-" bajo los elementos de la misma *
Parameters
inner
-
text
string Contenido de la celda.
draw
Con el "draw" esta vez usamos el "getContent" del padre y a los valores obtenidos le concatenamos una fila de "-" por debajo, del mismo tamaño que el conjunto de valores obtenidos con "getContent".
Parameters
Returns string text Celda dibujada.