Add files that fit into the naming scheme

1 files changed, 509 insertions, 0 deletions

diff --git a/testautomation/global/tools/includes/optional/t_treelist_tools.inc b/testautomation/global/tools/includes/optional/t_treelist_tools.inc
new file mode 100755
index 000000000000..a55036239a3d
--- /dev/null
+++ b/testautomation/global/tools/includes/optional/t_treelist_tools.inc
@@ -0,0 +1,509 @@
+'encoding UTF-8  Do not remove or change this line!
+'**************************************************************************
+'* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+'* 
+'* Copyright 2008 by Sun Microsystems, Inc.
+'*
+'* OpenOffice.org - a multi-platform office productivity suite
+'*
+'* $RCSfile: t_treelist_tools.inc,v $
+'*
+'* $Revision: 1.1 $
+'*
+'* last change: $Author: jsk $ $Date: 2008-06-20 07:59:34 $
+'*
+'* This file is part of OpenOffice.org.
+'*
+'* OpenOffice.org is free software: you can redistribute it and/or modify
+'* it under the terms of the GNU Lesser General Public License version 3
+'* only, as published by the Free Software Foundation.
+'*
+'* OpenOffice.org is distributed in the hope that it will be useful,
+'* but WITHOUT ANY WARRANTY; without even the implied warranty of
+'* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+'* GNU Lesser General Public License version 3 for more details
+'* (a copy is included in the LICENSE file that accompanied this code).
+'*
+'* You should have received a copy of the GNU Lesser General Public License
+'* version 3 along with OpenOffice.org.  If not, see
+'* <http://www.openoffice.org/license.html>
+'* for a copy of the LGPLv3 License.
+'*
+'/************************************************************************
+'*
+'* owner : joerg.skottke@sun.com
+'*
+'* short description : Helpers for accessing treelists
+'*
+'\******************************************************************************
+
+private const DEBUG_ENABLE = false
+
+function hGetNodeCount( oControl as object ) as integer
+    
+    '///<h3>Retrieve the number of visible (open) nodes from a treelist</h3>
+    '///<u>Input</u>:
+    '///<ol>
+    '///+<li>Treelist control object (Object)</li>
+    '///<ul>
+    '///+<li>Object must exist in current context</li>
+    '///</ul>
+    '///</ol>
+    '///<u>Returns</u>:
+    '///<ol>
+    '///+<li>Number of items in treelist</li>
+    '///<ul>
+    '///+<li>0 on any error</li>
+    '///+<li>&gt; 0 Number of items</li>
+    '///</ul>
+    '///</ol>
+    '///<u>Description</u>:
+    '///<ul>
+    
+    
+    const CFN = "hGetNodeCount::"
+    dim iCount as integer
+    
+    '///+<li>Verify that the control exists</li>
+    if ( oControl.exists( 5 ) ) then
+    
+        '///+<li>Verify that the control is enabled</li>
+        if ( oControl.isEnabled() ) then
+
+            if ( DEBUG_ENABLE ) then
+                printlog( CFN & "Regular access, control available and enabled" )
+            endif
+            
+            '///+<li>get the number of items from the control</li>
+            iCount = oControl.getItemCount()
+        else
+            printlog( CFN & "Failure: Control claims to be disabled." )
+            iCount = 0
+        endif
+    else
+        try
+            printlog( CFN & "Forcing access to non existing control" )
+            iCount = oControl.getItemCount()
+        catch
+            printlog( CFN & "Failure: Control not available." )
+            iCount = 0
+        endcatch
+    endif
+    if ( DEBUG_ENABLE ) then
+        printlog( CFN & "Exit with nodecount = " & iCount )
+    endif
+    hGetNodeCount = iCount
+    '///</ul>
+    
+end function
+
+'*******************************************************************************
+
+function hSelectTopNode( oControl as object ) as boolean
+    
+    '///<h3>Move selection to the first node in a treelist</h3>
+    '///<ul>
+    '///+<li>Type the &quot;Home&quot;-key in a treelist, to select index 1</li>
+    '///+<li>Verify that the top node has been selected</li>
+    '///</ul>
+
+    const CFN = "hSelectTopNode::"
+    
+    try
+        oControl.select( 1 ) 
+        WaitSlot()
+        hSelectTopNode() = true
+    catch
+        hSelectTopNode() = false
+    endcatch
+    
+    if ( DEBUG_ENABLE ) then
+        printlog( CFN & "Selected Node: " & oControl.getText() )
+    endif
+    
+end function
+
+'*******************************************************************************
+
+function hSelectNextNode( oControl as object ) as integer
+    
+    '///<h3>Move one node down in a treelist</h3>
+    '///<ul>
+    '///+<li>Returns new position or 0 on error</li>
+    '///</ul>
+    
+    const CFN = "hSelectNextNode::"
+    
+    dim iPosBefore as integer
+    dim iPosAfter as integer
+    
+    iPosBefore = oControl.getSelIndex()
+    
+    oControl.typeKeys( "<DOWN>" )
+    
+    iPosAfter = oControl.getSelIndex()
+    
+    if ( iPosAfter = iPosBefore ) then
+        hSelectNextNode() = 0
+    endif
+    
+    if ( iPosAfter = ( iPosBefore + 1 ) ) then
+        hSelectnextNode() = iPosAfter
+    endif
+    
+    printlog( CFN & "Selected node: " & oControl.getText() )
+    
+end function
+
+'*******************************************************************************
+
+function hGetNodeName( oControl as object , iNode as integer ) as string
+    
+    '///<h3>Retrieve the name of a node in a treelist specified by index</h3>
+    '///<ul>
+    '///+<li>Returns the name of the node or empty string on error</li>
+    '///</ul>
+    const CFN = "hGetNodeName::"
+    dim iItemCount as integer
+    
+    iItemCount = hGetNodeCount( oControl )
+    if ( iNode > iItemCount ) then
+        warnlog( CFN & "Selected node out of range, aborting" )
+        hGetNodeName() = ""
+    else
+        oControl.select( iNode )
+        hGetNodeName() = oControl.getSelText()
+    endif
+    
+end function
+
+'*******************************************************************************
+
+function hExpandNode( oControl as object, iNode as integer ) as integer
+    
+    '///<h3>Expand a node in a treelist specified by index</h3>
+    '///<ul>
+    '///+<li>Returns new nodecount or 0 on error</li>
+    '///</ul>
+    
+    const CFN = "hExpandNode::"
+    
+    dim iOldNodeCount as integer
+    
+    if ( DEBUG_ENABLE ) then 
+        printlog( CFN & "Enter with option (Control): " & oControl.name() )
+        printlog( CFN & "Enter with option (iNode): " & iNode )
+    endif
+    
+    iOldNodeCount = hGetNodeCount( oControl )
+    if ( iNode <= iOldNodeCount ) then
+        if ( iNode > 0 ) then
+            oControl.select( iNode )
+        endif
+        try
+            oControl.typekeys( "<RIGHT>" )
+            hExpandNode() = hGetNodeCount( oControl )
+        catch
+            warnlog( "#i84194# Treelist access failed (Keyboard navigation)" )
+            hExpandNode() = 0
+        endcatch
+    else
+        hExpandNode() = 0
+    endif
+    
+end function
+
+'*******************************************************************************
+
+function hExpandAllNodes( oControl as object ) as integer
+    
+    '///<h3>Expand all nodes of treelist</h3>
+    '///<ul>
+    '///+<li>Run through all items in the treelist, expand every node</li>
+    '///+<li>Returns the number of all nodes in the treelist</li>
+    '///</ul>
+    
+    dim iNode as integer
+    dim iNodeCurCount as integer
+    dim iNodeRefCount as integer
+    dim iIteration as integer
+    
+    const CFN = "hExpandAllNodes::"
+    
+    hSelectTopNode( oControl )
+    iNodeCurCount = hGetNodeCount( oControl )
+    iNodeRefCount = -1
+    iIteration = 0
+    
+    if ( DEBUG_ENABLE ) then
+        printlog( CFN & "Initial iNodeCurCount: " & iNodeCurCount )
+        printlog( CFN & "Initial iNodeRefCount: " & iNodeRefCount )    
+    endif
+    
+    do while ( iNodeRefCount < iNodeCurCount )
+    
+        iIteration = iIteration + 1
+        iNodeRefCount = iNodeCurCount
+    
+        for iNode = iNodeCurCount to 1 step -1 
+            hExpandNode( oControl , iNode )
+        next iNode
+        
+        iNodeCurCount = hGetNodeCount( oControl )
+        
+        if ( DEBUG_ENABLE ) then
+            printlog( "" )
+            printlog( CFN & "Exit iteration....: " & iIteration    )
+            printlog( CFN & "Exit iNodeCurCount: " & iNodeCurCount )
+            printlog( CFN & "Exit iNodeRefCount: " & iNodeRefCount )    
+        endif
+        
+    loop
+    
+    if ( DEBUG_ENABLE ) then
+        printlog( CFN & "Exit with " & iNodeCurCount & _
+        " items after " & iIteration & " iterations" )
+    endif
+    hExpandAllNodes() = iNodeCurCount
+    
+end function
+
+'*******************************************************************************
+
+function hGetVisibleNodeNames( oControl as object , lsList() as string ) as integer
+    
+    '///<h3>Retrieve the names of all nodes in a treelist</h3>
+    '///<ul>
+    '///+<li>Expand all nodes of a treelist</li>
+    '///+<li>Store all node names into an array</li>
+    '///+<li>Return the number of nodes read (listcount), 0 on error</li>
+    '///</ul>
+    
+    ' Get the list of all visible (expanded) nodes and store it
+    ' in lsList(). if _id > ubound lsList() an error is given and lsList remains
+    ' empty, thus returning "0"
+    
+    const CFN = "hGetVisibleNodeNames::"
+    
+    dim iNodeCount as integer
+    dim iThisNode as integer
+    
+    printlog( CFN & "Enter" )
+    
+    iNodeCount = hGetNodeCount( oControl )
+
+    ' Test whether the array provided is large enough to hold all items
+    ' from the treelist/list. If the array is ok fill it.    
+    if ( iNodeCount > ubound( lsList() ) ) then
+        warnlog( "Array to small to hold: " & iNodeCount & " items" )
+    else
+        hSelectTopNode( oControl )
+        for iThisNode = 1 to iNodeCount
+            listappend( lsList() , hGetNodeName( oControl , iThisNode )
+        next iThisNode
+    endif
+    
+    hGetVisibleNodeNames() = listcount( lsList() )
+    printlog( CFN & "Exit" )
+    
+end function
+
+'*******************************************************************************
+
+function hSelectNode( oControl as object , _id as integer ) as string
+    
+    '///<h3>Select a node in a treelist by index</h3>
+    '///<ul>
+    '///+<li>Return the name of the selected node</li>
+    '///</ul>
+    
+    oControl.select( _id ) : hSelectNode() = hGetNodeName( oControl , _id )
+    
+end function
+
+'*******************************************************************************
+
+function hSelectNodeByName( oControl as object , _name as string ) as integer
+    
+    '///<h3>Select a node by name in treelist (first occurrence)</h3>
+    '///<ul>
+    '///+<li>Try to find a node by name - directly</li>
+    '///+<li>If the node is not visible, expand all and search the tree</li>
+    '///+<li>Returns index of requested node or 0 on failure</li>
+    '///</ul>
+    
+    const CFN = "hSelectNodeByName::"
+    
+    dim iThisNode as integer
+    dim iCurrentNode as integer
+    dim iNodeCount as integer
+    
+    dim cNodeName as string
+    
+    printlog( CFN & "Enter with option (NodeName): " & _name )
+    
+    iThisNode = 0
+    
+    ' First we try to jump to the node directly, if this fails we use the
+    ' slower but safer method (expand all nodes and step through)
+    try
+        oControl.select( _name )
+        iThisNode = oControl.getSelIndex()
+        hSelectNodeByName() = iThisNode
+    catch
+        printlog( CFN & "Node not visible: Using search method" )
+        iNodeCount = hExpandAllNodes( oControl )
+        
+        for iCurrentNode = 1 to iNodeCount
+            oControl.select( iCurrentNode )
+            cNodeName = oControl.getSelText()
+            
+            if ( cNodeName = _name ) then
+                iThisNode = iCurrentNode
+                exit for
+            endif
+        next iCurrentNode
+    endcatch
+    
+    if ( iThisNode = 0 ) then
+        printlog( CFN & "Exit: Node not found." )
+    else
+        printlog( CFN & "Exit: Node selected at pos: " & iThisNode )
+    endif
+    
+    hSelectNodeByName() = iThisNode
+    
+end function
+
+'*******************************************************************************
+
+function hSelectTheLastNode( oControl as object ) as integer
+    
+    '///<h3>Select the (absolute) last node in a treelist</h3>
+    '///<ul>
+    '///+<li>Expand all nodes</li>
+    '///+<li>Go to the last node, select it</li>
+    '///+<li>Return the number of the last node in the treelist</li>
+    '///</ul>
+    
+    const CFN = "hSelectTheLastNode::"
+    dim iCurrentNodeCount as integer
+    
+    printlog( CFN & "Enter with option (control): " & oControl.name() )
+    
+    iCurrentNodeCount = -1
+    
+    do while( iCurrentNodeCount < hGetNodeCount( oControl ) )
+    
+        iCurrentNodeCount = hGetNodeCount( oControl )
+        hExpandNode( oControl, iCurrentNodeCount )
+        
+        if ( DEBUG_ENABLE ) then
+            printlog( CFN & "Nodename.....: " & oControl.getText() )
+            printlog( CFN & "Node position: " & iCurrentNodeCount )
+        endif
+        
+    loop
+    
+    printlog( CFN & "Exit with result: " & iCurrentNodeCount )
+    hSelectTheLastNode() = iCurrentNodeCount
+    
+end function
+
+'*******************************************************************************
+
+function hVerifyNodeName( oControl as object , cName as string ) as boolean
+    
+    '///<h3>Compare the name of the current node from a treelist to a reference string</h3>
+    '///<ul>
+    '///+<li>Returns true on success, false on failure</li>
+    '///</ul>
+    
+    hVerifyNodeName() = false
+    if ( oControl.getSelText() = cName ) then hVerifyNodeName() = true
+    
+end function
+
+'*******************************************************************************
+
+function hWaitForTreelist( oTreeList as object, cContext as string, iItemCount as integer ) as boolean
+    
+    '///<h3>Wait for a treelist to get populated (java related delay)</h3>
+    '///<b>IMPORTANT: Do not use unless absolutely necessary</b>
+    '///+<p>Retrieve the number of items from the treelist until a specified
+    '///+ number has been reached.</p>
+    
+    const CFN = "hWaitForTreelist::"
+    dim iTry as integer
+    dim iObjects as integer
+    dim brc as boolean
+    
+    brc = false
+    iTry = 0
+    
+    kontext cContext
+    
+    qaerrorlog( CFN & "Stupid function, do not use" )
+   
+    iObjects = 0
+    do while ( iObjects < iItemCount )
+        
+        iTry = iTry + 1
+        iObjects = hGetNodeCount( oTreeList )
+        
+        if ( iObjects >= iItemCount ) then
+       	    brc = true
+       	    exit do
+        endif
+
+        ' Failsafe mechanism
+        if ( iTry = 10 ) then
+            qaerrorlog( CFN & "Requested number of items never reached" )
+            brc = false
+            exit do
+        endif        
+
+    loop
+    
+    hWaitForTreelist() = brc
+    
+end function
+
+'******************************************************************************
+
+function hGetListItems( oControl as object, aList() as string ) as integer
+    
+    '///<h3>Retrieve the names of all nodes from a plain (linear) list</h3>
+    '///<ul>
+    '///+<li>Cycle through a list, append all entries to an array</li>
+    '///+<li>Returns number of items or 0 on error</li>
+    '///</ul>
+    
+    const CFN = "hGetListItems::"
+    
+    printlog( CFN & "Enter with option (control): " & oControl.name() )
+    
+    dim iItemCount as integer
+    dim iCurrentItem as integer
+    dim cCurrentItem as string
+    
+    iItemCount = oControl.getItemCount()
+    if ( iItemCount > ubound( aList() ) ) then
+        printlog( CFN & "Array too small, needed: " & iItemCount )
+        hGetListItems() = 0
+        exit function
+    endif
+    
+    for iCurrentItem = 1 to iItemCount
+        
+        oControl.select( iCurrentItem )
+        cCurrentItem = oControl.getSelText()
+        hListAppend( cCurrentItem, aList() )
+        
+    next iCurrentItem
+    
+    printlog( CFN & "Exit with  number of items: " & iItemCount )
+    hGetListItems() = iItemCount
+    
+end function
+