testautomation/framework/tools/includes/pbrowser_tools.inc

   1 'encoding UTF-8  Do not remove or change this line!
   2 '**************************************************************************
   3 ' DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4 '
   5 ' Copyright 2000, 2010 Oracle and/or its affiliates.
   6 '
   7 ' OpenOffice.org - a multi-platform office productivity suite
   8 '
   9 ' This file is part of OpenOffice.org.
  10 '
  11 ' OpenOffice.org is free software: you can redistribute it and/or modify
  12 ' it under the terms of the GNU Lesser General Public License version 3
  13 ' only, as published by the Free Software Foundation.
  14 '
  15 ' OpenOffice.org is distributed in the hope that it will be useful,
  16 ' but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ' GNU Lesser General Public License version 3 for more details
  19 ' (a copy is included in the LICENSE file that accompanied this code).
  20 '
  21 ' You should have received a copy of the GNU Lesser General Public License
  22 ' version 3 along with OpenOffice.org.  If not, see
  23 ' <http://www.openoffice.org/license.html>
  24 ' for a copy of the LGPLv3 License.
  25 '
  26 '/************************************************************************
  27 '*
  28 '*  owner : gregor.hartmann@oracle.com
  29 '*
  30 '*  short description : Tools for working with the property browser for formcontrols
  31 '*
  32 '\******************************************************************************
  33
  34 function hOpenPropertyBrowser() as boolean
  35
  36     '///<h3>Open the BASIC property browser</h3>
  37
  38     const CFN = "framework::tools::includes::pbrowser_tools.inc::hOpenPropertyBrowser(): "
  39
  40     kontext "ControlPropertiesTabControl"
  41     if ( ControlPropertiesTabControl.exists() ) then
  42         printlog( "Property Browser is already open, no action taken" )
  43         hOpenPropertyBrowser() = true
  44     else
  45         if ( hUseAsyncSlot( "ContextProperties" ) <> -1 ) then
  46             kontext "ControlPropertiesTabControl"
  47             if ( ControlPropertiesTabControl.exists( 2 ) ) then
  48                 ControlPropertiesTabControl.setPage( TabGeneralControl )
  49                 hOpenPropertyBrowser() = true
  50             else
  51                 warnlog( CFN & "Dialog <ControlPropertiesTabControl> is not available" )
  52                 hOpenPropertyBrowser() = false
  53             endif
  54         else
  55             warnlog( CFN & "Could not execute <ContextProperties> slot" )
  56             hOpenPropertyBrowser() = false
  57         endif
  58     endif
  59
  60 end function
  61
  62 '*******************************************************************************
  63
  64 function hClosePropertyBrowser() as boolean
  65
  66     const CFN = "framework::tools::includes::pbrowser_tools.inc::hClosePropertyBrowser(): "
  67     printlog( "Closing Property-Browser (if open)" )
  68
  69     kontext "ControlPropertiesTabControl"
  70     if ( ControlPropertiesTabControl.exists() ) then
  71
  72         hUseAsyncSlot( "ContextProperties" )
  73
  74         if ( ControlPropertiesTabControl.notExists( 2 ) ) then
  75             hClosePropertyBrowser() = true
  76         else
  77             warnlog( CFN & "Failed to close dialog" )
  78             hClosePropertyBrowser() = false
  79         endif
  80     else
  81         printlog( "Property browser is not open, no action taken." )
  82         hClosePropertyBrowser() = true
  83     endif
  84
  85 end function
  86
  87 '*******************************************************************************
  88
  89 function hPBSetControlName( cControl as string ) as boolean
  90
  91     '///<h3>Name a control, with limited errorhandling</h3>
  92
  93     '///<i>This function was introduced due to a problem with the property-
  94     '///browser not being open fast enough or just refusing to accept input</i><br><br>
  95
  96     '///<u>Input</u>:
  97     '///<ol>
  98     '///+<li>Text to be inserted in the control &quot;NameText&quot; (string)</li>
  99     '///</ol>
 100
 101     '///<u>Returns</u>:
 102     '///<ol>
 103
 104     '///+<li>Errorcondition</li>
 105     '///<ul>
 106     '///+<li>TRUE: The control name was successfully updated</li>
 107     '///+<li>FALSE: Control is not visible within current context</li>
 108     '///</ul>
 109
 110     '///</ol>
 111
 112     const CFN = "hPBSetControlName::"
 113
 114     '///<u>Description</u>:
 115     '///<ul>
 116     '///+<li>Test that the control &quot;NameText&quot; exists</li>
 117
 118     ' Note: A number of fallbacks are used here because the entryfield "NameText"
 119     ' is less than reliable. My hope is that one of the methods succeeds.
 120     kontext "TabGeneralControl"
 121     if ( NameText.exists() ) then
 122         '///+<li>Set the new name</li>
 123         hDeleteEntryFieldContent( NameText )
 124
 125         ' Name the control and append some Spaces which should be truncated.
 126         printlog( CFN & "Naming control: " & cControl )
 127         NameText.setText( cControl )
 128         TabGeneralControl.typeKeys( "<RETURN>" )
 129         WaitSlot()
 130
 131         if ( NameText.getText() = cControl ) then
 132             printlog( CFN & "Name is set ok: " & cControl )
 133             hPBSetControlName() = true
 134             exit function
 135         endif
 136
 137         ' If the name cannot be set this is in 99% of the cases a timing problem.
 138         ' Here is a (costly) workaround.
 139         qaerrorlog( CFN & "Name not set correctly, retrying" )
 140         Wait( 300 )
 141         NameText.setText( cControl )
 142         TabGeneralControl.typeKeys( "<RETURN>" )
 143         Wait( 300 )
 144
 145         ' Test again, leave function if good
 146         if ( NameText.getText() = cControl ) then
 147             printlog( CFN & "Name is set ok: " & cControl )
 148             hPBSetControlName() = true
 149             exit function
 150         endif
 151
 152         warnlog( CFN & "Unable to set control name: " & cControl )
 153         hPBSetControlName() = false
 154
 155     else
 156         warnlog( "Unable to name the control." )
 157         hPBSetControlName() = false
 158     endif
 159     '///</ul>
 160
 161 end function
 162
 163 '*******************************************************************************
 164
 165 function hPBGetControlName( cControl as string ) as boolean
 166
 167     '///<h3>Verify that the expected control is open</h3>
 168     '///<i>Use hPBSetControlName( string ) to set the name and when you reopen it
 169     '///+ verify that you got the right control wit this function</i><br><br>
 170
 171     '///<u>Input</u>:
 172     '///<ol>
 173     '///+<li>Name of the control (string)</li>
 174     '///</ol>
 175
 176     '///<u>Returns</u>:
 177     '///<ol>
 178
 179     '///+<li>Errorcondition (boolean)</li>
 180     '///<ul>
 181     '///+<li>TRUE: The control has the correct name</li>
 182     '///+<li>FALSE: Any other condition</li>
 183     '///</ul>
 184
 185     '///</ol>
 186
 187     '///<u>Description</u>:
 188     '///<ul>
 189
 190     dim cControlName as string
 191     const CFN = "hPBGetControlName::"
 192
 193     '///+<li>If &quot;NameText&quot; exists, retrieve its text</li>
 194     kontext "TabGeneralControl"
 195     if ( TabGeneralControl.exists( 1 ) ) then
 196         if ( TabGeneralControl.isVisible() ) then
 197             wait( 300 )
 198             cControlName = NameText.getText()
 199
 200             '///+<li>Verify that the name is correct</li>
 201             if ( cControlName = cControl ) then
 202                 printlog( CFN & "The name of the control is correct: " & cControl )
 203                 hPBGetControlName() = true
 204             else
 205                 warnlog( CFN & "Unexpected control name:" )
 206                 printlog( CFN & "Found....: " & cControlName )
 207                 printlog( CFN & "Expected.: " & cControl     )
 208                 hPBGetControlName() = false
 209             endif
 210         else
 211             warnlog( CFN & "Dialog present but tabpage could not be accessed (TabGeneralControl)." )
 212             hPBGetControlName() = false
 213         endif
 214     else
 215         warnlog( CFN & "Unable to get the name from the control, dialog not accessible (TabGeneralControl)." )
 216         hPBGetControlName() = false
 217     endif
 218     '///</ul>
 219
 220 end function
 221
 222 '*******************************************************************************
 223
 224 function hSetPBTabPage( iPage as integer ) as boolean
 225
 226     '///<h3>A small helper to switch between tabpages in the property-browser</h3>
 227     '///<u>Input</u>:
 228     '///<ol>
 229
 230     '///+<li>Page-ID (integer)</li>
 231     '///<ul>
 232     '///+<li>1 = General page</li>
 233     '///+<li>2 = Events page</li>
 234     '///</ul>
 235
 236     '///</ol>
 237
 238     '///<u>Returns</u>:
 239     '///<ol>
 240
 241     '///+<li>Errorcondition (boolean)</li>
 242     '///<ul>
 243     '///+<li>TRUE on success</li>
 244     '///+<li>FALSE on any error</li>
 245     '///</ul>
 246
 247     '///</ol>
 248
 249     '///<u>Description</u>:
 250     '///<ul>
 251
 252     const CFN = "hSetPBTabPage::"
 253     printlog( CFN & "Enter with option: " & iPage )
 254
 255     '///+<li>Switch to the requested page</li>
 256     kontext "ControlPropertiesTabControl"
 257     if ( not ControlPropertiesTabControl.exists( 3 ) ) then
 258         printlog( CFN & "Exit: Control Properties Dialog is not open, aborting" )
 259         hSetPBTabPage() = false
 260         exit function
 261     else
 262         if ( GVERBOSE ) then
 263             printlog( CFN & "Control Properties Dialog is open" )
 264         endif
 265     endif
 266
 267     select case iPage
 268     case 1
 269
 270         printlog( CFN & "Switching to control properties tabpage" )
 271         kontext "ControlPropertiesTabControl"
 272         ControlPropertiesTabControl.setPage TabGeneralControl
 273
 274         kontext "TabGeneralControl"
 275         if ( nametext.exists( 5 ) ) then
 276             printlog( CFN & "Exit: Control properties are open (true)" )
 277             hSetPBTabPage() = true
 278             exit function
 279         else
 280             printlog( CFN & "Exit: Failed to open Control Properties (false)" )
 281             hSetPBTabPage() = false
 282             exit function
 283         endif
 284
 285     case 2
 286
 287         printlog( CFN & "Switching to event assignment tabpage" )
 288         kontext "ControlPropertiesTabControl"
 289         ControlPropertiesTabControl.setPage TabEventsControl
 290
 291         kontext "TabEventsControl"
 292         if ( PBFocusGained.exists( 5 ) ) then
 293             printlog( CFN & "Exit: Events page is open (true)" )
 294             hSetPBTabPage() = true
 295             exit function
 296         else
 297             printlog( CFN & "Exit: Failed to open events-page (false)" )
 298             hSetPBTabPage() = false
 299             exit function
 300         endif
 301
 302     case else
 303
 304         printlog( CFN & "Invalid parameter passed to function: " & iPage )
 305         hSerPBTabPage() = false
 306         exit function
 307
 308     end select
 309     '///</ul>
 310
 311 end function
 312
 313 '*******************************************************************************
 314
 315 function hDeleteEntryFieldContent( oControl as object ) as boolean
 316
 317     printlog( "Original name is: " & oControl.getText() )
 318
 319     oControl.typeKeys( "<HOME>" )
 320     oControl.typeKeys( "<SHIFT END>" )
 321     oControl.typeKeys( "<DELETE>" )
 322
 323     if ( oControl.getText() = "" ) then
 324         hDeleteEntryFieldContent() = true
 325     else
 326         hDeleteEntryFieldContent() = false
 327     endif
 328
 329 end function