testautomation/global/tools/includes/optional/t_treelist_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 2008 by Sun Microsystems, Inc.
   6 '*
   7 '* OpenOffice.org - a multi-platform office productivity suite
   8 '*
   9 '* $RCSfile: t_treelist_tools.inc,v $
  10 '*
  11 '* $Revision: 1.1 $
  12 '*
  13 '* last change: $Author: jsk $ $Date: 2008-06-20 07:59:34 $
  14 '*
  15 '* This file is part of OpenOffice.org.
  16 '*
  17 '* OpenOffice.org is free software: you can redistribute it and/or modify
  18 '* it under the terms of the GNU Lesser General Public License version 3
  19 '* only, as published by the Free Software Foundation.
  20 '*
  21 '* OpenOffice.org is distributed in the hope that it will be useful,
  22 '* but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 '* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 '* GNU Lesser General Public License version 3 for more details
  25 '* (a copy is included in the LICENSE file that accompanied this code).
  26 '*
  27 '* You should have received a copy of the GNU Lesser General Public License
  28 '* version 3 along with OpenOffice.org.  If not, see
  29 '* <http://www.openoffice.org/license.html>
  30 '* for a copy of the LGPLv3 License.
  31 '*
  32 '/************************************************************************
  33 '*
  34 '* owner : joerg.skottke@sun.com
  35 '*
  36 '* short description : Helpers for accessing treelists
  37 '*
  38 '\******************************************************************************
  39
  40 private const DEBUG_ENABLE = false
  41
  42 function hGetNodeCount( oControl as object ) as integer
  43
  44     '///<h3>Retrieve the number of visible (open) nodes from a treelist</h3>
  45     '///<u>Input</u>:
  46     '///<ol>
  47     '///+<li>Treelist control object (Object)</li>
  48     '///<ul>
  49     '///+<li>Object must exist in current context</li>
  50     '///</ul>
  51     '///</ol>
  52     '///<u>Returns</u>:
  53     '///<ol>
  54     '///+<li>Number of items in treelist</li>
  55     '///<ul>
  56     '///+<li>0 on any error</li>
  57     '///+<li>&gt; 0 Number of items</li>
  58     '///</ul>
  59     '///</ol>
  60     '///<u>Description</u>:
  61     '///<ul>
  62
  63
  64     const CFN = "hGetNodeCount::"
  65     dim iCount as integer
  66
  67     '///+<li>Verify that the control exists</li>
  68     if ( oControl.exists( 5 ) ) then
  69
  70         '///+<li>Verify that the control is enabled</li>
  71         if ( oControl.isEnabled() ) then
  72
  73             if ( DEBUG_ENABLE ) then
  74                 printlog( CFN & "Regular access, control available and enabled" )
  75             endif
  76
  77             '///+<li>get the number of items from the control</li>
  78             iCount = oControl.getItemCount()
  79         else
  80             printlog( CFN & "Failure: Control claims to be disabled." )
  81             iCount = 0
  82         endif
  83     else
  84         try
  85             printlog( CFN & "Forcing access to non existing control" )
  86             iCount = oControl.getItemCount()
  87         catch
  88             printlog( CFN & "Failure: Control not available." )
  89             iCount = 0
  90         endcatch
  91     endif
  92     if ( DEBUG_ENABLE ) then
  93         printlog( CFN & "Exit with nodecount = " & iCount )
  94     endif
  95     hGetNodeCount = iCount
  96     '///</ul>
  97
  98 end function
  99
 100 '*******************************************************************************
 101
 102 function hSelectTopNode( oControl as object ) as boolean
 103
 104     '///<h3>Move selection to the first node in a treelist</h3>
 105     '///<ul>
 106     '///+<li>Type the &quot;Home&quot;-key in a treelist, to select index 1</li>
 107     '///+<li>Verify that the top node has been selected</li>
 108     '///</ul>
 109
 110     const CFN = "hSelectTopNode::"
 111
 112     try
 113         oControl.select( 1 )
 114         WaitSlot()
 115         hSelectTopNode() = true
 116     catch
 117         hSelectTopNode() = false
 118     endcatch
 119
 120     if ( DEBUG_ENABLE ) then
 121         printlog( CFN & "Selected Node: " & oControl.getText() )
 122     endif
 123
 124 end function
 125
 126 '*******************************************************************************
 127
 128 function hSelectNextNode( oControl as object ) as integer
 129
 130     '///<h3>Move one node down in a treelist</h3>
 131     '///<ul>
 132     '///+<li>Returns new position or 0 on error</li>
 133     '///</ul>
 134
 135     const CFN = "hSelectNextNode::"
 136
 137     dim iPosBefore as integer
 138     dim iPosAfter as integer
 139
 140     iPosBefore = oControl.getSelIndex()
 141
 142     oControl.typeKeys( "<DOWN>" )
 143
 144     iPosAfter = oControl.getSelIndex()
 145
 146     if ( iPosAfter = iPosBefore ) then
 147         hSelectNextNode() = 0
 148     endif
 149
 150     if ( iPosAfter = ( iPosBefore + 1 ) ) then
 151         hSelectnextNode() = iPosAfter
 152     endif
 153
 154     printlog( CFN & "Selected node: " & oControl.getText() )
 155
 156 end function
 157
 158 '*******************************************************************************
 159
 160 function hGetNodeName( oControl as object , iNode as integer ) as string
 161
 162     '///<h3>Retrieve the name of a node in a treelist specified by index</h3>
 163     '///<ul>
 164     '///+<li>Returns the name of the node or empty string on error</li>
 165     '///</ul>
 166     const CFN = "hGetNodeName::"
 167     dim iItemCount as integer
 168
 169     iItemCount = hGetNodeCount( oControl )
 170     if ( iNode > iItemCount ) then
 171         warnlog( CFN & "Selected node out of range, aborting" )
 172         hGetNodeName() = ""
 173     else
 174         oControl.select( iNode )
 175         hGetNodeName() = oControl.getSelText()
 176     endif
 177
 178 end function
 179
 180 '*******************************************************************************
 181
 182 function hExpandNode( oControl as object, iNode as integer ) as integer
 183
 184     '///<h3>Expand a node in a treelist specified by index</h3>
 185     '///<ul>
 186     '///+<li>Returns new nodecount or 0 on error</li>
 187     '///</ul>
 188
 189     const CFN = "hExpandNode::"
 190
 191     dim iOldNodeCount as integer
 192
 193     if ( DEBUG_ENABLE ) then
 194         printlog( CFN & "Enter with option (Control): " & oControl.name() )
 195         printlog( CFN & "Enter with option (iNode): " & iNode )
 196     endif
 197
 198     iOldNodeCount = hGetNodeCount( oControl )
 199     if ( iNode <= iOldNodeCount ) then
 200         if ( iNode > 0 ) then
 201             oControl.select( iNode )
 202         endif
 203         try
 204             oControl.typekeys( "<RIGHT>" )
 205             hExpandNode() = hGetNodeCount( oControl )
 206         catch
 207             warnlog( "#i84194# Treelist access failed (Keyboard navigation)" )
 208             hExpandNode() = 0
 209         endcatch
 210     else
 211         hExpandNode() = 0
 212     endif
 213
 214 end function
 215
 216 '*******************************************************************************
 217
 218 function hExpandAllNodes( oControl as object ) as integer
 219
 220     '///<h3>Expand all nodes of treelist</h3>
 221     '///<ul>
 222     '///+<li>Run through all items in the treelist, expand every node</li>
 223     '///+<li>Returns the number of all nodes in the treelist</li>
 224     '///</ul>
 225
 226     dim iNode as integer
 227     dim iNodeCurCount as integer
 228     dim iNodeRefCount as integer
 229     dim iIteration as integer
 230
 231     const CFN = "hExpandAllNodes::"
 232
 233     hSelectTopNode( oControl )
 234     iNodeCurCount = hGetNodeCount( oControl )
 235     iNodeRefCount = -1
 236     iIteration = 0
 237
 238     if ( DEBUG_ENABLE ) then
 239         printlog( CFN & "Initial iNodeCurCount: " & iNodeCurCount )
 240         printlog( CFN & "Initial iNodeRefCount: " & iNodeRefCount )
 241     endif
 242
 243     do while ( iNodeRefCount < iNodeCurCount )
 244
 245         iIteration = iIteration + 1
 246         iNodeRefCount = iNodeCurCount
 247
 248         for iNode = iNodeCurCount to 1 step -1
 249             hExpandNode( oControl , iNode )
 250         next iNode
 251
 252         iNodeCurCount = hGetNodeCount( oControl )
 253
 254         if ( DEBUG_ENABLE ) then
 255             printlog( "" )
 256             printlog( CFN & "Exit iteration....: " & iIteration    )
 257             printlog( CFN & "Exit iNodeCurCount: " & iNodeCurCount )
 258             printlog( CFN & "Exit iNodeRefCount: " & iNodeRefCount )
 259         endif
 260
 261     loop
 262
 263     if ( DEBUG_ENABLE ) then
 264         printlog( CFN & "Exit with " & iNodeCurCount & _
 265         " items after " & iIteration & " iterations" )
 266     endif
 267     hExpandAllNodes() = iNodeCurCount
 268
 269 end function
 270
 271 '*******************************************************************************
 272
 273 function hGetVisibleNodeNames( oControl as object , lsList() as string ) as integer
 274
 275     '///<h3>Retrieve the names of all nodes in a treelist</h3>
 276     '///<ul>
 277     '///+<li>Expand all nodes of a treelist</li>
 278     '///+<li>Store all node names into an array</li>
 279     '///+<li>Return the number of nodes read (listcount), 0 on error</li>
 280     '///</ul>
 281
 282     ' Get the list of all visible (expanded) nodes and store it
 283     ' in lsList(). if _id > ubound lsList() an error is given and lsList remains
 284     ' empty, thus returning "0"
 285
 286     const CFN = "hGetVisibleNodeNames::"
 287
 288     dim iNodeCount as integer
 289     dim iThisNode as integer
 290
 291     printlog( CFN & "Enter" )
 292
 293     iNodeCount = hGetNodeCount( oControl )
 294
 295     ' Test whether the array provided is large enough to hold all items
 296     ' from the treelist/list. If the array is ok fill it.
 297     if ( iNodeCount > ubound( lsList() ) ) then
 298         warnlog( "Array to small to hold: " & iNodeCount & " items" )
 299     else
 300         hSelectTopNode( oControl )
 301         for iThisNode = 1 to iNodeCount
 302             listappend( lsList() , hGetNodeName( oControl , iThisNode )
 303         next iThisNode
 304     endif
 305
 306     hGetVisibleNodeNames() = listcount( lsList() )
 307     printlog( CFN & "Exit" )
 308
 309 end function
 310
 311 '*******************************************************************************
 312
 313 function hSelectNode( oControl as object , _id as integer ) as string
 314
 315     '///<h3>Select a node in a treelist by index</h3>
 316     '///<ul>
 317     '///+<li>Return the name of the selected node</li>
 318     '///</ul>
 319
 320     oControl.select( _id ) : hSelectNode() = hGetNodeName( oControl , _id )
 321
 322 end function
 323
 324 '*******************************************************************************
 325
 326 function hSelectNodeByName( oControl as object , _name as string ) as integer
 327
 328     '///<h3>Select a node by name in treelist (first occurrence)</h3>
 329     '///<ul>
 330     '///+<li>Try to find a node by name - directly</li>
 331     '///+<li>If the node is not visible, expand all and search the tree</li>
 332     '///+<li>Returns index of requested node or 0 on failure</li>
 333     '///</ul>
 334
 335     const CFN = "hSelectNodeByName::"
 336
 337     dim iThisNode as integer
 338     dim iCurrentNode as integer
 339     dim iNodeCount as integer
 340
 341     dim cNodeName as string
 342
 343     printlog( CFN & "Enter with option (NodeName): " & _name )
 344
 345     iThisNode = 0
 346
 347     ' First we try to jump to the node directly, if this fails we use the
 348     ' slower but safer method (expand all nodes and step through)
 349     try
 350         oControl.select( _name )
 351         iThisNode = oControl.getSelIndex()
 352         hSelectNodeByName() = iThisNode
 353     catch
 354         printlog( CFN & "Node not visible: Using search method" )
 355         iNodeCount = hExpandAllNodes( oControl )
 356
 357         for iCurrentNode = 1 to iNodeCount
 358             oControl.select( iCurrentNode )
 359             cNodeName = oControl.getSelText()
 360
 361             if ( cNodeName = _name ) then
 362                 iThisNode = iCurrentNode
 363                 exit for
 364             endif
 365         next iCurrentNode
 366     endcatch
 367
 368     if ( iThisNode = 0 ) then
 369         printlog( CFN & "Exit: Node not found." )
 370     else
 371         printlog( CFN & "Exit: Node selected at pos: " & iThisNode )
 372     endif
 373
 374     hSelectNodeByName() = iThisNode
 375
 376 end function
 377
 378 '*******************************************************************************
 379
 380 function hSelectTheLastNode( oControl as object ) as integer
 381
 382     '///<h3>Select the (absolute) last node in a treelist</h3>
 383     '///<ul>
 384     '///+<li>Expand all nodes</li>
 385     '///+<li>Go to the last node, select it</li>
 386     '///+<li>Return the number of the last node in the treelist</li>
 387     '///</ul>
 388
 389     const CFN = "hSelectTheLastNode::"
 390     dim iCurrentNodeCount as integer
 391
 392     printlog( CFN & "Enter with option (control): " & oControl.name() )
 393
 394     iCurrentNodeCount = -1
 395
 396     do while( iCurrentNodeCount < hGetNodeCount( oControl ) )
 397
 398         iCurrentNodeCount = hGetNodeCount( oControl )
 399         hExpandNode( oControl, iCurrentNodeCount )
 400
 401         if ( DEBUG_ENABLE ) then
 402             printlog( CFN & "Nodename.....: " & oControl.getText() )
 403             printlog( CFN & "Node position: " & iCurrentNodeCount )
 404         endif
 405
 406     loop
 407
 408     printlog( CFN & "Exit with result: " & iCurrentNodeCount )
 409     hSelectTheLastNode() = iCurrentNodeCount
 410
 411 end function
 412
 413 '*******************************************************************************
 414
 415 function hVerifyNodeName( oControl as object , cName as string ) as boolean
 416
 417     '///<h3>Compare the name of the current node from a treelist to a reference string</h3>
 418     '///<ul>
 419     '///+<li>Returns true on success, false on failure</li>
 420     '///</ul>
 421
 422     hVerifyNodeName() = false
 423     if ( oControl.getSelText() = cName ) then hVerifyNodeName() = true
 424
 425 end function
 426
 427 '*******************************************************************************
 428
 429 function hWaitForTreelist( oTreeList as object, cContext as string, iItemCount as integer ) as boolean
 430
 431     '///<h3>Wait for a treelist to get populated (java related delay)</h3>
 432     '///<b>IMPORTANT: Do not use unless absolutely necessary</b>
 433     '///+<p>Retrieve the number of items from the treelist until a specified
 434     '///+ number has been reached.</p>
 435
 436     const CFN = "hWaitForTreelist::"
 437     dim iTry as integer
 438     dim iObjects as integer
 439     dim brc as boolean
 440
 441     brc = false
 442     iTry = 0
 443
 444     kontext cContext
 445
 446     qaerrorlog( CFN & "Stupid function, do not use" )
 447
 448     iObjects = 0
 449     do while ( iObjects < iItemCount )
 450
 451         iTry = iTry + 1
 452         iObjects = hGetNodeCount( oTreeList )
 453
 454         if ( iObjects >= iItemCount ) then
 455             brc = true
 456             exit do
 457         endif
 458
 459         ' Failsafe mechanism
 460         if ( iTry = 10 ) then
 461             qaerrorlog( CFN & "Requested number of items never reached" )
 462             brc = false
 463             exit do
 464         endif
 465
 466     loop
 467
 468     hWaitForTreelist() = brc
 469
 470 end function
 471
 472 '******************************************************************************
 473
 474 function hGetListItems( oControl as object, aList() as string ) as integer
 475
 476     '///<h3>Retrieve the names of all nodes from a plain (linear) list</h3>
 477     '///<ul>
 478     '///+<li>Cycle through a list, append all entries to an array</li>
 479     '///+<li>Returns number of items or 0 on error</li>
 480     '///</ul>
 481
 482     const CFN = "hGetListItems::"
 483
 484     printlog( CFN & "Enter with option (control): " & oControl.name() )
 485
 486     dim iItemCount as integer
 487     dim iCurrentItem as integer
 488     dim cCurrentItem as string
 489
 490     iItemCount = oControl.getItemCount()
 491     if ( iItemCount > ubound( aList() ) ) then
 492         printlog( CFN & "Array too small, needed: " & iItemCount )
 493         hGetListItems() = 0
 494         exit function
 495     endif
 496
 497     for iCurrentItem = 1 to iItemCount
 498
 499         oControl.select( iCurrentItem )
 500         cCurrentItem = oControl.getSelText()
 501         hListAppend( cCurrentItem, aList() )
 502
 503     next iCurrentItem
 504
 505     printlog( CFN & "Exit with  number of items: " & iItemCount )
 506     hGetListItems() = iItemCount
 507
 508 end function
 509