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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "cellbindinghandler.hxx"
#include "formstrings.hxx"
#include "formmetadata.hxx"
#include "cellbindinghelper.hxx"
#include <com/sun/star/form/binding/XValueBinding.hpp>
#include <com/sun/star/lang/NullPointerException.hpp>
#include <com/sun/star/table/CellAddress.hpp>
#include <com/sun/star/inspection/XObjectInspectorUI.hpp>
#include <tools/debug.hxx>
#include <tools/diagnose_ex.h>
namespace pcr
{
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::table;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::script;
using namespace ::com::sun::star::frame;
using namespace ::com::sun::star::inspection;
using namespace ::com::sun::star::form::binding;
using namespace ::comphelper;
CellBindingPropertyHandler::CellBindingPropertyHandler( const Reference< XComponentContext >& _rxContext )
:PropertyHandlerComponent( _rxContext )
,m_pCellExchangeConverter( new DefaultEnumRepresentation( *m_pInfoService, ::cppu::UnoType<sal_Int16>::get(), PROPERTY_ID_CELL_EXCHANGE_TYPE ) )
{
}
OUString CellBindingPropertyHandler::getImplementationName( )
{
return "com.sun.star.comp.extensions.CellBindingPropertyHandler";
}
Sequence< OUString > CellBindingPropertyHandler::getSupportedServiceNames( )
{
return { "com.sun.star.form.inspection.CellBindingPropertyHandler" };
}
void CellBindingPropertyHandler::onNewComponent()
{
PropertyHandlerComponent::onNewComponent();
Reference< XModel > xDocument( impl_getContextDocument_nothrow() );
DBG_ASSERT( xDocument.is(), "CellBindingPropertyHandler::onNewComponent: no document!" );
if ( CellBindingHelper::isSpreadsheetDocument( xDocument ) )
m_pHelper.reset( new CellBindingHelper( m_xComponent, xDocument ) );
}
CellBindingPropertyHandler::~CellBindingPropertyHandler( )
{
}
Sequence< OUString > SAL_CALL CellBindingPropertyHandler::getActuatingProperties( )
{
Sequence< OUString > aInterestingProperties{ PROPERTY_LIST_CELL_RANGE,
PROPERTY_BOUND_CELL,
PROPERTY_CONTROLSOURCE };
return aInterestingProperties;
}
void SAL_CALL CellBindingPropertyHandler::actuatingPropertyChanged( const OUString& _rActuatingPropertyName, const Any& _rNewValue, const Any& /*_rOldValue*/, const Reference< XObjectInspectorUI >& _rxInspectorUI, sal_Bool _bFirstTimeInit )
{
::osl::MutexGuard aGuard( m_aMutex );
PropertyId nActuatingPropId( impl_getPropertyId_throwRuntime( _rActuatingPropertyName ) );
OSL_PRECOND(m_pHelper,
"CellBindingPropertyHandler::actuatingPropertyChanged: inconsistency!");
// if we survived impl_getPropertyId_throwRuntime, we should have a helper, since no helper implies no properties
OSL_PRECOND( _rxInspectorUI.is(), "FormComponentPropertyHandler::actuatingPropertyChanged: no access to the UI!" );
if ( !_rxInspectorUI.is() )
throw NullPointerException();
std::vector< PropertyId > aDependentProperties;
switch ( nActuatingPropId )
{
// ----- BoundCell -----
case PROPERTY_ID_BOUND_CELL:
{
// the SQL-data-binding related properties need to be enabled if and only if
// there is *no* valid cell binding
Reference< XValueBinding > xBinding;
_rNewValue >>= xBinding;
if ( impl_isSupportedProperty_nothrow( PROPERTY_ID_CELL_EXCHANGE_TYPE ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_CELL_EXCHANGE_TYPE, xBinding.is() );
if ( impl_componentHasProperty_throw( PROPERTY_CONTROLSOURCE ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_CONTROLSOURCE, !xBinding.is() );
if ( impl_isSupportedProperty_nothrow( PROPERTY_ID_FILTERPROPOSAL ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_FILTERPROPOSAL, !xBinding.is() );
if ( impl_isSupportedProperty_nothrow( PROPERTY_ID_EMPTY_IS_NULL ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_EMPTY_IS_NULL, !xBinding.is() );
aDependentProperties.push_back( PROPERTY_ID_BOUNDCOLUMN );
if ( !xBinding.is() && m_pHelper->getCurrentBinding().is() )
{
// ensure that the "transfer selection as" property is reset. Since we can't remember
// it at the object itself, but derive it from the binding only, we have to normalize
// it now that there *is* no binding anymore.
setPropertyValue( PROPERTY_CELL_EXCHANGE_TYPE, makeAny( sal_Int16(0) ) );
}
}
break;
// ----- CellRange -----
case PROPERTY_ID_LIST_CELL_RANGE:
{
// the list source related properties need to be enabled if and only if
// there is *no* valid external list source for the control
Reference< XListEntrySource > xSource;
_rNewValue >>= xSource;
_rxInspectorUI->enablePropertyUI( PROPERTY_STRINGITEMLIST, !xSource.is() );
_rxInspectorUI->enablePropertyUI( PROPERTY_LISTSOURCE, !xSource.is() );
_rxInspectorUI->enablePropertyUI( PROPERTY_LISTSOURCETYPE, !xSource.is() );
aDependentProperties.push_back( PROPERTY_ID_BOUNDCOLUMN );
// also reset the list entries if the cell range is reset
// #i28319#
if ( !_bFirstTimeInit )
{
try
{
if ( !xSource.is() )
{
setPropertyValue( PROPERTY_STRINGITEMLIST, makeAny( Sequence< OUString >() ) );
setPropertyValue( PROPERTY_TYPEDITEMLIST, makeAny( Sequence< Any >() ) );
}
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION(
"extensions.propctrlr",
"ListCellRange: caught an exception while resetting the string items!");
}
}
}
break; // case PROPERTY_ID_LIST_CELL_RANGE
// ----- DataField -----
case PROPERTY_ID_CONTROLSOURCE:
{
OUString sControlSource;
_rNewValue >>= sControlSource;
if ( impl_isSupportedProperty_nothrow( PROPERTY_ID_BOUND_CELL ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_BOUND_CELL, sControlSource.isEmpty() );
}
break; // case PROPERTY_ID_CONTROLSOURCE
default:
OSL_FAIL( "CellBindingPropertyHandler::actuatingPropertyChanged: did not register for this property!" );
}
for (auto const& dependentProperty : aDependentProperties)
{
impl_updateDependentProperty_nothrow( dependentProperty, _rxInspectorUI );
}
}
void CellBindingPropertyHandler::impl_updateDependentProperty_nothrow( PropertyId _nPropId, const Reference< XObjectInspectorUI >& _rxInspectorUI ) const
{
try
{
switch ( _nPropId )
{
// ----- BoundColumn -----
case PROPERTY_ID_BOUNDCOLUMN:
{
CellBindingPropertyHandler* pNonConstThis = const_cast< CellBindingPropertyHandler* >( this );
Reference< XValueBinding > xBinding( pNonConstThis->getPropertyValue( PROPERTY_BOUND_CELL ), UNO_QUERY );
Reference< XListEntrySource > xListSource( pNonConstThis->getPropertyValue( PROPERTY_LIST_CELL_RANGE ), UNO_QUERY );
if ( impl_isSupportedProperty_nothrow( PROPERTY_ID_BOUNDCOLUMN ) )
_rxInspectorUI->enablePropertyUI( PROPERTY_BOUNDCOLUMN, !xBinding.is() && !xListSource.is() );
}
break; // case PROPERTY_ID_BOUNDCOLUMN
} // switch
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingPropertyHandler::impl_updateDependentProperty_nothrow" );
}
}
Any SAL_CALL CellBindingPropertyHandler::getPropertyValue( const OUString& _rPropertyName )
{
::osl::MutexGuard aGuard( m_aMutex );
PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
OSL_ENSURE(m_pHelper, "CellBindingPropertyHandler::getPropertyValue: inconsistency!");
// if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
Any aReturn;
switch ( nPropId )
{
case PROPERTY_ID_BOUND_CELL:
{
Reference< XValueBinding > xBinding( m_pHelper->getCurrentBinding() );
if ( !CellBindingHelper::isCellBinding( xBinding ) )
xBinding.clear();
aReturn <<= xBinding;
}
break;
case PROPERTY_ID_LIST_CELL_RANGE:
{
Reference< XListEntrySource > xSource( m_pHelper->getCurrentListSource() );
if ( !CellBindingHelper::isCellRangeListSource( xSource ) )
xSource.clear();
aReturn <<= xSource;
}
break;
case PROPERTY_ID_CELL_EXCHANGE_TYPE:
{
Reference< XValueBinding > xBinding( m_pHelper->getCurrentBinding() );
aReturn <<= static_cast<sal_Int16>( CellBindingHelper::isCellIntegerBinding( xBinding ) ? 1 : 0 );
}
break;
default:
OSL_FAIL( "CellBindingPropertyHandler::getPropertyValue: cannot handle this!" );
break;
}
return aReturn;
}
void SAL_CALL CellBindingPropertyHandler::setPropertyValue( const OUString& _rPropertyName, const Any& _rValue )
{
::osl::MutexGuard aGuard( m_aMutex );
PropertyId nPropId( impl_getPropertyId_throwUnknownProperty( _rPropertyName ) );
OSL_ENSURE(m_pHelper, "CellBindingPropertyHandler::setPropertyValue: inconsistency!");
// if we survived impl_getPropertyId_throwUnknownProperty, we should have a helper, since no helper implies no properties
try
{
Any aOldValue = getPropertyValue( _rPropertyName );
switch ( nPropId )
{
case PROPERTY_ID_BOUND_CELL:
{
Reference< XValueBinding > xBinding;
_rValue >>= xBinding;
m_pHelper->setBinding( xBinding );
}
break;
case PROPERTY_ID_LIST_CELL_RANGE:
{
Reference< XListEntrySource > xSource;
_rValue >>= xSource;
m_pHelper->setListSource( xSource );
}
break;
case PROPERTY_ID_CELL_EXCHANGE_TYPE:
{
sal_Int16 nExchangeType = 0;
OSL_VERIFY( _rValue >>= nExchangeType );
Reference< XValueBinding > xBinding = m_pHelper->getCurrentBinding( );
if ( xBinding.is() )
{
bool bNeedIntegerBinding = ( nExchangeType == 1 );
if ( bNeedIntegerBinding != CellBindingHelper::isCellIntegerBinding( xBinding ) )
{
CellAddress aAddress;
if ( m_pHelper->getAddressFromCellBinding( xBinding, aAddress ) )
{
xBinding = m_pHelper->createCellBindingFromAddress( aAddress, bNeedIntegerBinding );
m_pHelper->setBinding( xBinding );
}
}
}
}
break;
default:
OSL_FAIL( "CellBindingPropertyHandler::setPropertyValue: cannot handle this!" );
break;
}
impl_setContextDocumentModified_nothrow();
Any aNewValue( getPropertyValue( _rPropertyName ) );
firePropertyChange( _rPropertyName, nPropId, aOldValue, aNewValue );
// TODO/UNOize: can't we make this a part of the base class, for all those "virtual"
// properties? Base class'es |setPropertyValue| could call some |doSetPropertyValue|,
// and handle the listener notification itself
}
catch( const Exception& )
{
TOOLS_WARN_EXCEPTION( "extensions.propctrlr", "CellBindingPropertyHandler::setPropertyValue" );
}
}
Any SAL_CALL CellBindingPropertyHandler::convertToPropertyValue( const OUString& _rPropertyName, const Any& _rControlValue )
{
::osl::MutexGuard aGuard( m_aMutex );
Any aPropertyValue;
OSL_ENSURE(
m_pHelper,
"CellBindingPropertyHandler::convertToPropertyValue: we have no SupportedProperties!");
if (!m_pHelper)
return aPropertyValue;
PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
OUString sControlValue;
OSL_VERIFY( _rControlValue >>= sControlValue );
switch( nPropId )
{
case PROPERTY_ID_LIST_CELL_RANGE:
aPropertyValue <<= m_pHelper->createCellListSourceFromStringAddress( sControlValue );
break;
case PROPERTY_ID_BOUND_CELL:
{
// if we have the possibility of an integer binding, then we must preserve
// this property's value (e.g. if the current binding is an integer binding, then
// the newly created one must be, too)
bool bIntegerBinding = false;
if ( m_pHelper->isCellIntegerBindingAllowed() )
{
sal_Int16 nCurrentBindingType = 0;
getPropertyValue( PROPERTY_CELL_EXCHANGE_TYPE ) >>= nCurrentBindingType;
bIntegerBinding = ( nCurrentBindingType != 0 );
}
aPropertyValue <<= m_pHelper->createCellBindingFromStringAddress( sControlValue, bIntegerBinding );
}
break;
case PROPERTY_ID_CELL_EXCHANGE_TYPE:
m_pCellExchangeConverter->getValueFromDescription( sControlValue, aPropertyValue );
break;
default:
OSL_FAIL( "CellBindingPropertyHandler::convertToPropertyValue: cannot handle this!" );
break;
}
return aPropertyValue;
}
Any SAL_CALL CellBindingPropertyHandler::convertToControlValue( const OUString& _rPropertyName,
const Any& _rPropertyValue, const Type& /*_rControlValueType*/ )
{
::osl::MutexGuard aGuard( m_aMutex );
Any aControlValue;
OSL_ENSURE(
m_pHelper,
"CellBindingPropertyHandler::convertToControlValue: we have no SupportedProperties!");
if (!m_pHelper)
return aControlValue;
PropertyId nPropId( m_pInfoService->getPropertyId( _rPropertyName ) );
switch ( nPropId )
{
case PROPERTY_ID_BOUND_CELL:
{
Reference< XValueBinding > xBinding;
bool bSuccess = _rPropertyValue >>= xBinding;
OSL_ENSURE( bSuccess, "CellBindingPropertyHandler::convertToControlValue: invalid value (1)!" );
// the only value binding we support so far is linking to spreadsheet cells
aControlValue <<= m_pHelper->getStringAddressFromCellBinding( xBinding );
}
break;
case PROPERTY_ID_LIST_CELL_RANGE:
{
Reference< XListEntrySource > xSource;
bool bSuccess = _rPropertyValue >>= xSource;
OSL_ENSURE( bSuccess, "CellBindingPropertyHandler::convertToControlValue: invalid value (2)!" );
// the only value binding we support so far is linking to spreadsheet cells
aControlValue <<= m_pHelper->getStringAddressFromCellListSource( xSource );
}
break;
case PROPERTY_ID_CELL_EXCHANGE_TYPE:
aControlValue <<= m_pCellExchangeConverter->getDescriptionForValue( _rPropertyValue );
break;
default:
OSL_FAIL( "CellBindingPropertyHandler::convertToControlValue: cannot handle this!" );
break;
}
return aControlValue;
}
Sequence< Property > CellBindingPropertyHandler::doDescribeSupportedProperties() const
{
std::vector< Property > aProperties;
bool bAllowCellLinking = m_pHelper && m_pHelper->isCellBindingAllowed();
bool bAllowCellIntLinking = m_pHelper && m_pHelper->isCellIntegerBindingAllowed();
bool bAllowListCellRange = m_pHelper && m_pHelper->isListCellRangeAllowed();
if ( bAllowCellLinking || bAllowListCellRange || bAllowCellIntLinking )
{
sal_Int32 nPos = ( bAllowCellLinking ? 1 : 0 )
+ ( bAllowListCellRange ? 1 : 0 )
+ ( bAllowCellIntLinking ? 1 : 0 );
aProperties.resize( nPos );
if ( bAllowCellLinking )
{
aProperties[ --nPos ] = Property( PROPERTY_BOUND_CELL, PROPERTY_ID_BOUND_CELL,
::cppu::UnoType<OUString>::get(), 0 );
}
if ( bAllowCellIntLinking )
{
aProperties[ --nPos ] = Property( PROPERTY_CELL_EXCHANGE_TYPE, PROPERTY_ID_CELL_EXCHANGE_TYPE,
::cppu::UnoType<sal_Int16>::get(), 0 );
}
if ( bAllowListCellRange )
{
aProperties[ --nPos ] = Property( PROPERTY_LIST_CELL_RANGE, PROPERTY_ID_LIST_CELL_RANGE,
::cppu::UnoType<OUString>::get(), 0 );
}
}
if ( aProperties.empty() )
return Sequence< Property >();
return comphelper::containerToSequence(aProperties);
}
} // namespace pcr
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
extensions_propctrlr_CellBindingPropertyHandler_get_implementation(
css::uno::XComponentContext* context , css::uno::Sequence<css::uno::Any> const&)
{
return cppu::acquire(new pcr::CellBindingPropertyHandler(context));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|