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