FWMBrowse
FWMBrowse():New() --> oSelfClase para construir y controlar pantallas browse en el Framework de Protheus. Centraliza columnas, búsquedas, filtros, leyendas, sucursales y el ciclo de vida de la interfaz.
Descripción general
FWMBrowse proporciona una capa de alto nivel para construir pantallas browse en el Framework de Protheus. La rutina crea el objeto, define alias, descripción, filtros, campos, leyendas y otros recursos y, solo después, activa la interfaz con Activate().
Sintaxis
FWMBrowse():New() --> oSelfMétodos
NewCrea un nuevo objeto FWMBrowse.FWMBrowse():New()-> oSelf
SetAliasMétodo de la clase FWMBrowse.FWMBrowse():SetAlias( <cAlias> ) -> NIL
cAliasCarácterObligatorioAlias de la tabla utilizado por el browse.
SetDescriptionMétodo de la clase FWMBrowse.FWMBrowse():SetDescription( <cDescription> ) -> NIL
cDescriptionCarácterObligatorioDescripción mostrada para el browse.
SetCanSaveAreaMétodo de la clase FWMBrowse.FWMBrowse():SetCanSaveArea( <lCanSaveArea> ) -> NIL
lCanSaveAreaLógicoObligatorioControla si el browse puede guardar y restaurar el área de trabajo actual.
ActivateActiva el browse y muestra la interfaz configurada.FWMBrowse():Activate(< oOwner >)-> NIL
oOwnerObjetoObligatorioObjeto propietario del browse.
AfterExecuteActualiza los límites del browse después de una acción, restaura el contexto del archivo de empresas y libera el bloqueo del registro.FWMBrowse():AfterExecute(< cFunction >, < nOption >, < nVerify >)-> NIL
cFunctionCarácterObligatorioFunción asociada a la acción seleccionada.
nOptionNuméricoObligatorioTipo de operación solicitada en el browse.
nVerifyNuméricoObligatorioPosición de permiso que debe validarse para el usuario actual.
AddLegendAgrega una leyenda visual basada en una condición.FWMBrowse():AddLegend(< xCondition >, < cColor >, [< cTitle >] , [< cID >] , [< lFilter >] )-> NIL
xConditionCaracter ou bloco de códigoObligatorioExpresión AdvPL o bloque de código que determina cuándo se aplica la leyenda.
cColorCarácterObligatorioColor utilizado por la leyenda.
cTitleCarácterOpcionalTítulo opcional de la leyenda o ventana.
cIDCarácterOpcionalIdentificador opcional de la leyenda.
lFilterLógicoOpcionalControla la disponibilidad o ejecución inmediata del filtro, según el método.
BeforeExecuteVerifica permisos de acceso y si el registro seleccionado puede modificarse antes de ejecutar una acción.FWMBrowse():BeforeExecute(< cFunction >, < nOption >, < nVerify >, < cTitle >, < nRealOpc >, < nRotina >)-> NIL
cFunctionCarácterObligatorioFunción asociada a la acción seleccionada.
nOptionNuméricoObligatorioTipo de operación solicitada en el browse.
nVerifyNuméricoObligatorioPosición de permiso que debe validarse para el usuario actual.
cTitleCarácterObligatorioTítulo opcional de la leyenda o ventana.
nRealOpcNuméricoObligatorioOpción real seleccionada en el menú.
nRotinaNuméricoObligatorioPosición del elemento de rutina al que se accede.
BrwGetFilDevuelve la descripción de una sucursal.FWMBrowse():BrwGetFil(< cFil >)-> cLasFil
cFilCarácterObligatorioCódigo de la sucursal.
ChangeTopBotActualiza los límites superior e inferior del browse y puede aplicar el filtro inmediatamente.FWMBrowse():ChangeTopBot(< lDoFilter >)-> NIL
lDoFilterLógicoObligatorioIndica si el filtro debe ejecutarse inmediatamente.
CheckPermVerifica si el usuario tiene permiso para ejecutar la acción solicitada.FWMBrowse():CheckPerm(< cFunction >, < nOption >, < nVerify >, < lShowHelp >)-> NIL
cFunctionCarácterObligatorioFunción asociada a la acción seleccionada.
nOptionNuméricoObligatorioTipo de operación solicitada en el browse.
nVerifyNuméricoObligatorioPosición de permiso que debe validarse para el usuario actual.
lShowHelpLógicoObligatorioControla si se muestra al usuario la ayuda de permisos.
ClassNameDevuelve el nombre de la clase FWMBROWSE.FWMBrowse():ClassName()-> cClassName
ColumnsFieldsConstruye columnas adicionales del browse a partir de la estructura suministrada mediante SetFields.FWMBrowse():ColumnsFields(< aColumns >)-> NIL
aColumnsMatriz de registrosObligatorioMatriz que describe las columnas del browse. Consulte la referencia TOTVS para la estructura posicional completa.
DeActivateDesactiva el browse y finaliza su ciclo de interfaz activa.FWMBrowse():DeActivate()-> NIL
ExecuteMDefEjecuta la acción seleccionada en el menú funcional.FWMBrowse():ExecuteMDef()-> NIL
GetCBoxDevuelve el contenido mostrado para un campo configurado con opciones X3_CBOX.FWMBrowse():GetCBox(< nPosSx3 >, < cCampo >)-> cConteud
nPosSx3NuméricoObligatorioPosición del campo en la matriz del diccionario de datos.
cCampoCarácterObligatorioCampo que contiene las opciones configuradas.
GetSizeCBoxDevuelve el ancho necesario para una columna configurada con opciones X3_CBOX.FWMBrowse():GetSizeCBox(< nPosSx3 >)-> nSize
nPosSx3NuméricoObligatorioPosición del campo en la matriz del diccionario de datos.
GetTimerDevuelve el objeto TIMER asociado al browse.FWMBrowse():GetTimer()-> oTimer
LoadColumnsCarga las columnas estándar del browse o los campos configurados para una tabla temporal.FWMBrowse():LoadColumns(< cProfFields >)-> aColumns
cProfFieldsCarácterObligatorioCadena que contiene los campos de la estructura MBrowse heredada.
LoadFilsDevuelve las sucursales disponibles para el usuario actual en el alias seleccionado.FWMBrowse():LoadFils(< cAlias >)-> aFilial
cAliasCarácterObligatorioAlias de la tabla utilizado por el browse.
SetAmbienteHabilita la opción relacionada con Ambiente/Walk-Thru en el browse.FWMBrowse():SetAmbiente(< lAmbiente >)-> NIL
lAmbienteLógicoObligatorioHabilita la opción Ambiente.
SetBotFunDefine el límite inferior utilizado por el browse.FWMBrowse():SetBotFun(< cBotFun >)-> NIL
cBotFunCarácterObligatorioLímite inferior del browse.
SetChgAllControla si el usuario puede modificar registros de otras sucursales.FWMBrowse():SetChgAll(< lChgAll >)-> NIL
lChgAllLógicoObligatorioPermite modificar registros de otras sucursales.
SetExecuteDefDefine qué opción del browse se ejecuta al hacer doble clic en un elemento.FWMBrowse():SetExecuteDef(< nExecuteDef >)-> NIL
nExecuteDefNuméricoObligatorioOpción del browse ejecutada con doble clic.
SetFieldsDefine campos o estructuras de columnas que se agregarán al browse.FWMBrowse():SetFields(< aFields >)-> NIL
aFieldsMatriz de registrosObligatorioMatriz de campos o definiciones de columnas utilizadas por el browse.
SetFilialDefine las sucursales consideradas al mostrar registros en el browse.FWMBrowse():SetFilial(< aFils >)-> NIL
aFilsMatriz de registrosObligatorioMatriz que contiene las sucursales que se mostrarán.
SetIniWindowDefine un bloque de código ejecutado al inicializar la ventana del browse.FWMBrowse():SetIniWindow(< bIniWindow >)-> NIL
bIniWindowBloque de códigoObligatorioBloque de código ejecutado al iniciar la ventana del browse.
SetSeeAllControla si el usuario puede visualizar registros de otras sucursales.FWMBrowse():SetSeeAll(< lSeeAll >)-> NIL
lSeeAllLógicoObligatorioPermite visualizar registros de otras sucursales.
SetSeekHabilita la búsqueda de registros y permite suministrar una estructura de búsqueda personalizada.FWMBrowse():SetSeek(< lSeek >, < aSeek >)-> NIL
lSeekLógicoObligatorioHabilita la búsqueda en el browse.
aSeekMatriz de registrosObligatorioMatriz que describe opciones de búsqueda personalizadas.
SetTimerConfigura un bloque de código y un intervalo para actualizaciones periódicas del browse.FWMBrowse():SetTimer(< bTimerAction >, < nInterval >)-> NIL
bTimerActionBloque de códigoObligatorioBloque de código ejecutado en cada actualización del temporizador.
nIntervalNuméricoObligatorioIntervalo de actualización.
SetTopFunDefine el límite superior utilizado por el browse.FWMBrowse():SetTopFun(< cTopFun >)-> NIL
cTopFunCarácterObligatorioLímite superior del browse.
SetUseFilterHabilita el filtro estándar del browse.FWMBrowse():SetUseFilter(< lFilter >)-> NIL
lFilterLógicoObligatorioControla la disponibilidad o ejecución inmediata del filtro, según el método.
SetUseCaseFilterHabilita el filtro rápido del browse.FWMBrowse():SetUseCaseFilter(< lFilter >)-> NIL
lFilterLógicoObligatorioControla la disponibilidad o ejecución inmediata del filtro, según el método.
SetX3TelaDefine una regla utilizada por FWFormStruct para controlar qué campos del diccionario se presentan.FWMBrowse():SetX3Tela(< cTela >)-> NIL
cTelaCarácterObligatorioRegla utilizada para seleccionar los campos mostrados en el browse.
SetWalkThruHabilita la funcionalidad Walk-Thru en el browse.FWMBrowse():SetWalkThru(< lWalkThru >)-> NIL
lWalkThruLógicoObligatorioHabilita Walk-Thru.
SetOnlyFieldsRestringe el browse a los campos de tabla especificados.FWMBrowse():SetOnlyFields(< aFields >)-> NIL
aFieldsMatriz de registrosObligatorioMatriz de campos o definiciones de columnas utilizadas por el browse.
DestroyDestruye el objeto y libera sus referencias a otros objetos.FWMBrowse():Destroy()-> NIL
SetMainProcConfigura el comportamiento del proceso principal de FWMBrowse.FWMBrowse():SetMainProc()
OptionReportIndica si la opción de informe/impresión del browse está habilitada.FWMBrowse():OptionReport()-> lOptionReport
Ejemplo completo
Local oBrowse := FWMBrowse():New()
oBrowse:SetAlias("SA1")
oBrowse:SetDescription("Clientes")
oBrowse:SetUseFilter(.T.)
oBrowse:Activate()El browse se crea para el alias SA1, recibe una descripción y soporte de filtro y luego se activa.
- Configure el alias, la descripción, los filtros, los campos y las demás opciones antes de Activate().
- Mantenga las reglas de negocio fuera de la capa de presentación siempre que sea posible.
- Valide en el entorno Protheus los métodos que dependen de la versión de LIB y Framework.
- Al mantener código heredado, identifique primero si la rutina utiliza MBrowse, FWMBrowse o MVC.
- Activar el browse antes de finalizar su configuración puede producir un comportamiento incompleto.
- Algunos métodos dependen de estructuras internas del Framework y pueden variar según la versión de la LIB.
- Los ejemplos ilustrativos deben adaptarse al alias, menú y contexto reales de la rutina.
Comentarios
Todavía no hay comentarios aprobados.
Inicia sesión con Google o Microsoft para comentar.