Skip to content

Commit

Permalink
Generar documentación de la API
Browse files Browse the repository at this point in the history
  • Loading branch information
xaabi6 committed Dec 20, 2024
1 parent d5e2313 commit c26f665
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 41 deletions.
3 changes: 2 additions & 1 deletion doc/api/rup.select.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Opciones por defecto de configuración del componente.
| [typeAhead] | <code>number</code> | <code>false</code> | Especifica en milisegundos el tiempo de espera que toma el componente antes de procesar los eventos de escritura realizados por el usuario. |
| [legacyWrapMode] | <code>number</code> | <code>false</code> | Determina si se emplea el método obsoleto a la hora de empaquetar en objetos json los elementos seleccionados. Su propósito es mantener la retrocompatibilidad. |
| [autocomplete] | <code>boolean</code> | <code>false</code> | Habilita la funcionalidad de autocompletado, permitiendo hacer búsquedas sobre los resultados. |
| [spaceEnable] | <code>boolean</code> | <code>true</code> | Habilita la funcionalidad de búsquedas con barra espaciadora. |

<a name="module_rup_select..getRupValue"></a>

Expand Down Expand Up @@ -364,7 +365,7 @@ Permite consultar y modificar la configuración del componente.

**Example**
```js
// Establecer una propiedad$("#idSelect").rup_select("option", "minLegth", 2);// Establecer varias propiedad$("#idSelect").rup_select("option", {minLegth:2, delay:1000});
// Establecer una propiedad$("#idSelect").rup_select("option", "minimumResultsForSearch", 2);// Establecer varias propiedad$("#idSelect").rup_select("option", {minimumResultsForSearch:2, delay:1000});
```
<a name="module_rup_select..open"></a>

Expand Down
60 changes: 25 additions & 35 deletions doc/api/rup.table.buttons.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,21 @@ Genera los botones del table

**Summary**: Extensión del componente RUP Datatable
**Version**: 1.5.1
**License**: Licencia con arreglo a la EUPL, Versión 1.1 exclusivamente (la «Licencia»);Solo podrá usarse esta obra si se respeta la Licencia.Puede obtenerse una copia de la Licencia en http://ec.europa.eu/idabc/eupl.htmlSalvo cuando lo exija la legislación aplicable o se acuerde por escrito,el programa distribuido con arreglo a la Licencia se distribuye «TAL CUAL»,SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, ni expresas ni implícitas.Véase la Licencia en el idioma concreto que rige los permisos y limitacionesque establece la Licencia.
**License**: Licencia con arreglo a la EUPL, Versión 1.1 exclusivamente (la «Licencia»);
Solo podrá usarse esta obra si se respeta la Licencia.
Puede obtenerse una copia de la Licencia en

http://ec.europa.eu/idabc/eupl.html

Salvo cuando lo exija la legislación aplicable o se acuerde por escrito,
el programa distribuido con arreglo a la Licencia se distribuye «TAL CUAL»,
SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, ni expresas ni implícitas.
Véase la Licencia en el idioma concreto que rige los permisos y limitaciones
que establece la Licencia.
**Copyright**: Copyright 2018 E.J.I.E., S.A.

* [rup.table.buttons](#module_rup.table.buttons)
* [~Buttons(dt, config)](#module_rup.table.buttons..Buttons)
* [~action(Button)](#module_rup.table.buttons..action) ⇒ <code>function</code>
* [~action(node, action)](#module_rup.table.buttons..action) ⇒ <code>Buttons</code>
* [~active(node, [flag])](#module_rup.table.buttons..active) ⇒ <code>Buttons</code>
* [~add(config, [idx])](#module_rup.table.buttons..add) ⇒ <code>Buttons</code>
Expand All @@ -22,7 +31,6 @@ Genera los botones del table
* [~node(node)](#module_rup.table.buttons..node) ⇒ <code>jQuery</code>
* [~processing(flag)](#module_rup.table.buttons..processing) ⇒ <code>boolean</code> \| <code>Buttons</code>
* [~remove(node)](#module_rup.table.buttons..remove) ⇒ <code>Buttons</code>
* [~text(node)](#module_rup.table.buttons..text) ⇒ <code>string</code>
* [~text(node, label)](#module_rup.table.buttons..text) ⇒ <code>Buttons</code>
* [~_constructor()](#module_rup.table.buttons.._constructor)
* [~_addKey(conf)](#module_rup.table.buttons.._addKey)
Expand Down Expand Up @@ -69,18 +77,6 @@ Botones

<a name="module_rup.table.buttons..action"></a>

### rup.table.buttons~action(Button) ⇒ <code>function</code>
Get the action of a button

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0

| Param | Type | Description |
| --- | --- | --- |
| Button | <code>int</code> \| <code>string</code> | index |

<a name="module_rup.table.buttons..action"></a>

### rup.table.buttons~action(node, action) ⇒ <code>Buttons</code>
Set the action of a button

Expand All @@ -96,7 +92,8 @@ Set the action of a button
<a name="module_rup.table.buttons..active"></a>

### rup.table.buttons~active(node, [flag]) ⇒ <code>Buttons</code>
Add an active class to the button to make to look active or get currentactive state.
Add an active class to the button to make to look active or get current
active state.

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Returns**: <code>Buttons</code> - Self for chaining or boolean for getter
Expand Down Expand Up @@ -145,7 +142,8 @@ Disable a button
<a name="module_rup.table.buttons..destroy"></a>

### rup.table.buttons~destroy() ⇒ <code>Buttons</code>
Destroy the instance, cleaning up event handlers and removing DOMelements
Destroy the instance, cleaning up event handlers and removing DOM
elements

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Returns**: <code>Buttons</code> - Self for chaining
Expand Down Expand Up @@ -213,19 +211,6 @@ Remove a button.

<a name="module_rup.table.buttons..text"></a>

### rup.table.buttons~text(node) ⇒ <code>string</code>
Get the text for a button

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Returns**: <code>string</code> - Button text
**Since**: UDA 3.4.0 // Table 1.0.0

| Param | Type | Description |
| --- | --- | --- |
| node | <code>int</code> \| <code>string</code> | Button index |

<a name="module_rup.table.buttons..text"></a>

### rup.table.buttons~text(node, label) ⇒ <code>Buttons</code>
Set the text for a button

Expand Down Expand Up @@ -329,7 +314,8 @@ Get container array for a button from a button node (recursive)
<a name="module_rup.table.buttons.._keypress"></a>

### rup.table.buttons~\_keypress(character, e)
Handle a key press - determine if any button's key configured matcheswhat was typed and trigger the action if so.
Handle a key press - determine if any button's key configured matches
what was typed and trigger the action if so.

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0
Expand All @@ -342,7 +328,8 @@ Handle a key press - determine if any button's key configured matches what was t
<a name="module_rup.table.buttons.._removeKey"></a>

### rup.table.buttons~\_removeKey(conf)
Remove a key from the key listener for this instance (to be used when abutton is removed)
Remove a key from the key listener for this instance (to be used when a
button is removed)

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0
Expand Down Expand Up @@ -453,7 +440,8 @@ Desactiva el boton y su opcion dentro del context menu
<a name="module_rup.table.buttons.._manageButtonsAndButtonsContextMenu"></a>

### rup.table.buttons~\_manageButtonsAndButtonsContextMenu(opts, numOfSelectedRows, collectionObject)
Gestiona la propiedad de activado/desactivado de los botones y de sus opcionesdentro del context menu.
Gestiona la propiedad de activado/desactivado de los botones y de sus opciones
dentro del context menu.

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0
Expand All @@ -467,7 +455,8 @@ Gestiona la propiedad de activado/desactivado de los botones y de sus opciones d
<a name="module_rup.table.buttons.._reports"></a>

### rup.table.buttons~\_reports(dt, that, config)
Establece el tipo de llamada necesario para obtener los datos según lo seleccionadoe inicia la gestión para finalmente obtenerlos
Establece el tipo de llamada necesario para obtener los datos según lo seleccionado
e inicia la gestión para finalmente obtenerlos

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0
Expand Down Expand Up @@ -496,7 +485,8 @@ Se encarga de mapear los datos de json a datos separados por el tabulador.
<a name="module_rup.table.buttons.._reportsTypeOfCopy"></a>

### rup.table.buttons~\_reportsTypeOfCopy(dt, type, request, multiselection, selectedAll, [deselectedIds]) ⇒ <code>object</code>
Según el tipo de función de copia solicitada, realiza unas u otras comprobacionesantes de solicitar los datos al servidor
Según el tipo de función de copia solicitada, realiza unas u otras comprobaciones
antes de solicitar los datos al servidor

**Kind**: inner method of [<code>rup.table.buttons</code>](#module_rup.table.buttons)
**Since**: UDA 3.4.0 // Table 1.0.0
Expand Down
2 changes: 1 addition & 1 deletion doc/api/rup.table.editForm.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Función que gestiona la carga del diálogo de añadir o editar.
<a name="module_rup.table.editForm..validarFormulario"></a>

### rup.table.editForm~validarFormulario(ctx, lastAction, actionType, row)
Valida los formularios para no, buscarlos.
Valida los formularios para no buscarlos.

**Kind**: inner method of [<code>rup.table.editForm</code>](#module_rup.table.editForm)
**Since**: UDA 5.0.2 // Table 1.0.0
Expand Down
2 changes: 1 addition & 1 deletion doc/api/rup.upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Elimina los objetos jQuery asociados al elemento identificado por el selector, d
**Kind**: inner method of [<code>rup\_upload</code>](#module_rup_upload)
**Example**
```js
$(selector).rup_combo("destroy");
$(selector).rup_upload("destroy");
```
<a name="module_rup_upload..enable"></a>

Expand Down
6 changes: 3 additions & 3 deletions doc/api/rup.validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ var properties={ rules:{ "campoObligatorio":{required:true}, "dni"
* [rup_validate](#module_rup_validate)
* [~destroy()](#module_rup_validate..destroy)
* [~resetForm()](#module_rup_validate..resetForm)
* [~resetForm()](#module_rup_validate..resetForm)
* [~resetElements()](#module_rup_validate..resetElements)

<a name="module_rup_validate..destroy"></a>

Expand All @@ -35,9 +35,9 @@ Se realiza un reset del formulario y se eliminan los mensajes de error de las re
```js
$("#formValidaciones").rup_validate("resetForm");
```
<a name="module_rup_validate..resetForm"></a>
<a name="module_rup_validate..resetElements"></a>

### rup_validate~resetForm()
### rup_validate~resetElements()
Se eliminan los menssajes de error de las reglas de validacion.

**Kind**: inner method of [<code>rup\_validate</code>](#module_rup_validate)
Expand Down

0 comments on commit c26f665

Please sign in to comment.