icc.ui.button

Representa un botón presionable por el usuario. Adicionalmente este puede tener un icono y un texto informativo.

Metodos

create ();

Crea los objetos necesarios en el navegador.Este metódo es ejecutado automaticamente por el sistema al cargar un formulario realizado por el diseñador.Si está creando mediante código un control para incluir al formulario en tiempo de ejecución es necesario llamar a este metodo.


object getWnd ();

Retorna el objeto html que contiene el control.


setCaption ( string  caption );
captionTexto a mostrar por el control.

Setea el texto mostrado por el control


setEnabled ( boolean  enabled );

Habilita o habilita este control. En ciertos controles como textinput aplican los colores de fondo y texto correspondientes al estado disabled y el control no muestra su contenido al usuario.


setIcon ( string  iconName );
iconNameNombre de archivo de una imagen del proyecto ej. 'thumbs.png' o el nombre de una imagen de stock del sistema si el nombre comienza con el caracter '!' ej !arrow_left.png.
Eventos

onClick (function( ) { ... } )

Evento disparado cuando el usuario presiona el botón.

Ejemplo
					
button1.onClick(function(){
    alert("button1 click");
});

					

beforeClick (function( ) { ... } )

Evento disparado antes del onClick, retornando false en este evento se suprime el evento onClick. Al suprimir el evento onClick también se suprime cualquier acción asociada al botón.

Ejemplo
					
// consideramos que el botón esta vinculado a un origen de datos de clientes y 
//la accion 'save'
btnSaveClientes.beforeClick(function(){
    // confirm retorna true si presionamos ok o false si lo hacemos en cancel
    // al presionar cancel retornamos false y se cancelan todas las acciones
    // posteriores.
    return confirm('Desea guardar los datos ingresados ?');
});

					

onPostExecute (function( boolean  status , object  error ) { ... } )
statusEstado final de la ejecución de la acción.
errorObjeto con información del error producido al ejecutar la acción. Es esperable que este parámetro sea undefined si status es igual a true.

Evento disparado luego del onClick y luego de que la acción asociada con el botón ej. 'save' ha finalizado.

Ejemplo
					
button1.onPostExecute(function(status,error){
    if(status){
        alert("Los datos han sido guardados correctamente.")
    }else{
        alert(error.description);
    }
});

					
Propiedades

string caption

Texto de la etiqueta.


string datasource

Nombre del origen de datos desde donde el control obtiene los datos a mostrar


string action

Acción a ejecutar sobre el datasource asociado o sobre los datasources del formulario.

Opciones
Nombre Descripcion
add Si el origen de datos permite operaciones de insert el botón asociado a esta acción permite poner al mismo en modo new para que el usuario cree un nuevo registro.
edit Si el origen de datos permite operaciones de actualización (update) y tiene un registro activo el botón asociado a esta acción es habilitado permitiendo al usuario editar los datos en pantalla.
save Cuando el origen de datos está editando un registro nuevo o editando uno existente el botón con esta acción provoca que el origen de datos intente guardar los datos. También controla el estado del botón habilitandolo cuando la acción puede ser ejecutada.
delete Habilita el botón para borrar el registro activo previa confirmación.
cancel Cancela las operaciones new y edit y vuelve el origen de datos al modo de navegación (browse)
move-prev (Prev) Mueve el registro activo del datasource a la posición anterior.
move-next (Next) Mueve el registro activo del datasource a la siguiente posición.
refresh Cuando esta acción está definida en el formulario los cambios hechos en los controles destinados a datos de búsqueda no provocan el refrescado automático del contenido del origen de datos y debe presionarse el botón para hacerlo.
export Al presionar el boton de esta acción se exportan los datos actuales del origen de datos a formato csv.
edit-xxxx (edit using ..) Sintaxis especial para la acción 'edit' que permite cambiar al modo de edicion y abrir un formulario (xxxx) en una ventana modal dentro de la aplicación.
add-xxxx (add using ..) Sintaxis especial para la acción 'add' que permite cambiar al modo de new para que el usuario ingrese un nuevo registro utilizando el formulario (xxxx) en una ventana modal dentro de la aplicación.
view-xxxx (view using) Cuando el origen de datos tiene un registro activo permite abrir un formulario modal dentro de la aplicación para visualizar datos adicionales.
browse-xxxx (browse using) Abre un formulario modal dentro de la aplicacion pero no necesita tener un registro activo, lo que permite que este formulario se utilize para agregar nuevos registros, modificar etc. La única restricción para esta acción es que el origen de datos se encuentre en modo navegación (browse).
search-xxxx (search using) Abre un formulario en modo navegación que al cerrarlo con una accion 'Ok' posiciona el origen de datos en el registro seleccionado.
ok Cierra un formulario modal de manera que los datos seleccionados en una busqueda se utilizen por el formulario previo.
close Cierra un formulario modal de manera que los datos seleccionados en una busqueda sean descartados.
save-all Inspecciona todos los origenes de datos del formulario y ejecuta la accion 'save' para los que hayan sido modificados.
save-close Inspecciona todos los origenes de datos del formulario y ejecuta la accion 'save' para los que hayan sido modificados y cierra el formulario si todo fue grabado sactifactoriamente.
cancel-all Inspecciona todos los origenes de datos del formulario y ejecuta la accion 'cancel' para los que hayan sido modificados.
cancel-close Inspecciona todos los origenes de datos del formulario y ejecuta la accion 'cancel' para los que hayan sido modificados y cierra el formulario.

string tooltip

Texto del tooltip.


boolean enabled

Estado habilitado o deshabilitado.


boolean visible

Controla la visibilidad del control.


integer tabIndex

Orden del foco del teclado al presionar la tecla TAB


string style

Nombre de un estilo predefinido que setea una o mas propiedades.


string foreColor

Color del texto del control. El color es expresado en formato web #RRGGBB RR(rojo) GG(verde) BB(azul) ej. #FF0000 para el color rojo o en un nombre de color valido ej , green,red,yellow.


string backColor

Color de fondo del control. El color es expresado en formato web #RRGGBB RR(rojo) GG(verde) BB(azul) ej. #FF0000 para el color rojo o en un nombre de color valido ej , green,red,yellow.


integer borderWidth

Ancho en pixels del borde del control


string borderColor

Color de borde del control. El color es expresado en formato web #RRGGBB RR(rojo) GG(verde) BB(azul) ej. #FF0000 para el color rojo o en un nombre de color valido ej , green,red,yellow.


string icon

Nombre del icono a mostrar en el control que hace referencia a una imagen que forma parte de los recursos de la aplicacion en particular o a una de stock del sistema. Cuando se hace referencia a una imagen del sistema se debe prefijar con el caracter '!'.


string iconSide

El lado del botón donde es mostrado el icono. left,right,top,bottom


integer round

Magnitud que controla el redondeado de los bordes en botones y paneles.Valores típicos van desde 2 a 40.


object font

Tipografia del texto utilizado.

Miembros de la estructura
Tipo Nombre Descripcion
string name Nombre de la/s tipografía/s utilizada/s ej. 'Arial', 'Verdana'
integer size Tamaño de la letra en pixels
integer weight Peso o grosor de fuente ej 'normal','bold'
string italic Indica si la fuente es italica ej true, false

string align

Alineación del texto del control.

Opciones
Nombre Descripcion
left Alinea el texto a la izquierda
right Alinea el texto a la derecha
center Centra el texto en el control.(Solo aplicable a label y textinput)
justify Justifica el texto a lo ancho del control. (Solo aplicable a label y textinput)