forms/source/helper/formnavigation.cxx

   1 /*************************************************************************
   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: formnavigation.cxx,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_forms.hxx"
  33 #include "formnavigation.hxx"
  34 #include "urltransformer.hxx"
  35 #include "controlfeatureinterception.hxx"
  36 #include <tools/debug.hxx>
  37 #ifndef _SVX_SVXIDS_HRC
  38 #include <svx/svxids.hrc>
  39 #endif
  40 #include "frm_strings.hxx"
  41
  42 //.........................................................................
  43 namespace frm
  44 {
  45 //.........................................................................
  46
  47     using namespace ::com::sun::star::uno;
  48     using namespace ::com::sun::star::beans;
  49     using namespace ::com::sun::star::lang;
  50     using namespace ::com::sun::star::util;
  51     using namespace ::com::sun::star::frame;
  52
  53     //==================================================================
  54     //= OFormNavigationHelper
  55     //==================================================================
  56     DBG_NAME( OFormNavigationHelper )
  57     //------------------------------------------------------------------
  58     OFormNavigationHelper::OFormNavigationHelper( const Reference< XMultiServiceFactory >& _rxORB )
  59         :m_xORB( _rxORB )
  60         ,m_nConnectedFeatures( 0 )
  61     {
  62         DBG_CTOR( OFormNavigationHelper, NULL );
  63         m_pFeatureInterception.reset( new ControlFeatureInterception( m_xORB ) );
  64     }
  65
  66     //------------------------------------------------------------------
  67     OFormNavigationHelper::~OFormNavigationHelper()
  68     {
  69         DBG_DTOR( OFormNavigationHelper, NULL );
  70     }
  71
  72     //------------------------------------------------------------------
  73     void SAL_CALL OFormNavigationHelper::dispose( ) throw( RuntimeException )
  74     {
  75         m_pFeatureInterception->dispose();
  76         disconnectDispatchers();
  77     }
  78
  79     //------------------------------------------------------------------
  80     void OFormNavigationHelper::interceptorsChanged( )
  81     {
  82         updateDispatches();
  83     }
  84
  85     //------------------------------------------------------------------
  86     void OFormNavigationHelper::featureStateChanged( sal_Int32 /*_nFeatureId*/, sal_Bool /*_bEnabled*/ )
  87     {
  88         // not interested in
  89     }
  90
  91     //------------------------------------------------------------------
  92     void OFormNavigationHelper::allFeatureStatesChanged( )
  93     {
  94         // not interested in
  95     }
  96
  97     //------------------------------------------------------------------
  98     void SAL_CALL OFormNavigationHelper::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
  99     {
 100         m_pFeatureInterception->registerDispatchProviderInterceptor( _rxInterceptor );
 101         interceptorsChanged();
 102     }
 103
 104     //------------------------------------------------------------------
 105     void SAL_CALL OFormNavigationHelper::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
 106     {
 107         m_pFeatureInterception->releaseDispatchProviderInterceptor( _rxInterceptor );
 108         interceptorsChanged();
 109     }
 110
 111     //------------------------------------------------------------------
 112     void SAL_CALL OFormNavigationHelper::statusChanged( const FeatureStateEvent& _rState ) throw (RuntimeException)
 113     {
 114         for (   FeatureMap::iterator aFeature = m_aSupportedFeatures.begin();
 115                 aFeature != m_aSupportedFeatures.end();
 116                 ++aFeature
 117             )
 118         {
 119             if ( aFeature->second.aURL.Main == _rState.FeatureURL.Main )
 120             {
 121                 if  (  ( aFeature->second.bCachedState != _rState.IsEnabled )
 122                     || ( aFeature->second.aCachedAdditionalState != _rState.State )
 123                     )
 124                 {
 125                     // change the cached state
 126                     aFeature->second.bCachedState           = _rState.IsEnabled;
 127                     aFeature->second.aCachedAdditionalState = _rState.State;
 128                     // tell derivees what happened
 129                     featureStateChanged( aFeature->first, _rState.IsEnabled );
 130                 }
 131                 return;
 132             }
 133         }
 134
 135         // unreachable
 136         DBG_ERROR( "OFormNavigationHelper::statusChanged: huh? An invalid/unknown URL?" );
 137     }
 138
 139     //------------------------------------------------------------------
 140     void SAL_CALL OFormNavigationHelper::disposing( const EventObject& _rSource ) throw (RuntimeException)
 141     {
 142         // was it one of our external dispatchers?
 143         if ( m_nConnectedFeatures )
 144         {
 145             for (   FeatureMap::iterator aFeature = m_aSupportedFeatures.begin();
 146                     aFeature != m_aSupportedFeatures.end();
 147                     ++aFeature
 148                 )
 149             {
 150                 if ( aFeature->second.xDispatcher == _rSource.Source )
 151                 {
 152                     aFeature->second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), aFeature->second.aURL );
 153                     aFeature->second.xDispatcher = NULL;
 154                     aFeature->second.bCachedState = sal_False;
 155                     aFeature->second.aCachedAdditionalState.clear();
 156                     --m_nConnectedFeatures;
 157
 158                     featureStateChanged( aFeature->first, sal_False );
 159                     break;
 160                 }
 161             }
 162         }
 163     }
 164
 165     //------------------------------------------------------------------
 166     void OFormNavigationHelper::updateDispatches()
 167     {
 168         if ( !m_nConnectedFeatures )
 169         {       // we don't have any dispatchers yet -> do the initial connect
 170             connectDispatchers();
 171             return;
 172         }
 173
 174         initializeSupportedFeatures();
 175
 176         m_nConnectedFeatures = 0;
 177
 178         Reference< XDispatch >  xNewDispatcher;
 179         Reference< XDispatch >  xCurrentDispatcher;
 180
 181         for (   FeatureMap::iterator aFeature = m_aSupportedFeatures.begin();
 182                 aFeature != m_aSupportedFeatures.end();
 183                 ++aFeature
 184             )
 185         {
 186             xNewDispatcher = queryDispatch( aFeature->second.aURL );
 187             xCurrentDispatcher = aFeature->second.xDispatcher;
 188             if ( xNewDispatcher != xCurrentDispatcher )
 189             {
 190                 // the dispatcher for this particular URL changed
 191                 if ( xCurrentDispatcher.is() )
 192                     xCurrentDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), aFeature->second.aURL );
 193
 194                 xCurrentDispatcher = aFeature->second.xDispatcher = xNewDispatcher;
 195
 196                 if ( xCurrentDispatcher.is() )
 197                     xCurrentDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), aFeature->second.aURL );
 198             }
 199
 200             if ( xCurrentDispatcher.is() )
 201                 ++m_nConnectedFeatures;
 202             else
 203                 aFeature->second.bCachedState = sal_False;
 204         }
 205
 206         // notify derivee that (potentially) all features changed their state
 207         allFeatureStatesChanged( );
 208     }
 209
 210     //------------------------------------------------------------------
 211     void OFormNavigationHelper::connectDispatchers()
 212     {
 213         if ( m_nConnectedFeatures )
 214         {       // already connected -> just do an update
 215             updateDispatches();
 216             return;
 217         }
 218
 219         initializeSupportedFeatures();
 220
 221         m_nConnectedFeatures = 0;
 222
 223         for (   FeatureMap::iterator aFeature = m_aSupportedFeatures.begin();
 224                 aFeature != m_aSupportedFeatures.end();
 225                 ++aFeature
 226             )
 227         {
 228             aFeature->second.bCachedState = sal_False;
 229             aFeature->second.aCachedAdditionalState.clear();
 230             aFeature->second.xDispatcher = queryDispatch( aFeature->second.aURL );
 231             if ( aFeature->second.xDispatcher.is() )
 232             {
 233                 ++m_nConnectedFeatures;
 234                 aFeature->second.xDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), aFeature->second.aURL );
 235             }
 236         }
 237
 238         // notify derivee that (potentially) all features changed their state
 239         allFeatureStatesChanged( );
 240     }
 241
 242     //------------------------------------------------------------------
 243     void OFormNavigationHelper::disconnectDispatchers()
 244     {
 245         if ( m_nConnectedFeatures )
 246         {
 247             for (   FeatureMap::iterator aFeature = m_aSupportedFeatures.begin();
 248                     aFeature != m_aSupportedFeatures.end();
 249                     ++aFeature
 250                 )
 251             {
 252                 if ( aFeature->second.xDispatcher.is() )
 253                     aFeature->second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), aFeature->second.aURL );
 254
 255                 aFeature->second.xDispatcher = NULL;
 256                 aFeature->second.bCachedState = sal_False;
 257                 aFeature->second.aCachedAdditionalState.clear();
 258             }
 259
 260             m_nConnectedFeatures = 0;
 261         }
 262
 263         // notify derivee that (potentially) all features changed their state
 264         allFeatureStatesChanged( );
 265     }
 266
 267     //------------------------------------------------------------------
 268     void OFormNavigationHelper::initializeSupportedFeatures( )
 269     {
 270         if ( m_aSupportedFeatures.empty() )
 271         {
 272             // ask the derivee which feature ids it wants us to support
 273             ::std::vector< sal_Int32 > aFeatureIds;
 274             getSupportedFeatures( aFeatureIds );
 275
 276             OFormNavigationMapper aUrlMapper( m_xORB );
 277
 278             for (   ::std::vector< sal_Int32 >::const_iterator aLoop = aFeatureIds.begin();
 279                     aLoop != aFeatureIds.end();
 280                     ++aLoop
 281                 )
 282             {
 283                 FeatureInfo aFeatureInfo;
 284
 285                 bool bKnownId =
 286                     aUrlMapper.getFeatureURL( *aLoop, aFeatureInfo.aURL );
 287                 DBG_ASSERT( bKnownId, "OFormNavigationHelper::initializeSupportedFeatures: unknown feature id!" );
 288
 289                 if ( bKnownId )
 290                     // add to our map
 291                     m_aSupportedFeatures.insert( FeatureMap::value_type( *aLoop, aFeatureInfo ) );
 292             }
 293         }
 294     }
 295
 296     //------------------------------------------------------------------
 297     Reference< XDispatch > OFormNavigationHelper::queryDispatch( const URL& _rURL )
 298     {
 299         return m_pFeatureInterception->queryDispatch( _rURL );
 300     }
 301
 302     //------------------------------------------------------------------
 303     void OFormNavigationHelper::dispatchWithArgument( sal_Int32 _nFeatureId, const sal_Char* _pParamAsciiName,
 304         const Any& _rParamValue ) const
 305     {
 306         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 307         if ( m_aSupportedFeatures.end() != aInfo )
 308         {
 309             if ( aInfo->second.xDispatcher.is() )
 310             {
 311                 Sequence< PropertyValue > aArgs( 1 );
 312                 aArgs[0].Name = ::rtl::OUString::createFromAscii( _pParamAsciiName );
 313                 aArgs[0].Value = _rParamValue;
 314
 315                 aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aArgs );
 316             }
 317         }
 318     }
 319
 320     //------------------------------------------------------------------
 321     void OFormNavigationHelper::dispatch( sal_Int32 _nFeatureId ) const
 322     {
 323         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 324         if ( m_aSupportedFeatures.end() != aInfo )
 325         {
 326             if ( aInfo->second.xDispatcher.is() )
 327             {
 328                 Sequence< PropertyValue > aEmptyArgs;
 329                 aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aEmptyArgs );
 330             }
 331         }
 332     }
 333
 334     //------------------------------------------------------------------
 335     bool OFormNavigationHelper::isEnabled( sal_Int32 _nFeatureId ) const
 336     {
 337         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 338         if ( m_aSupportedFeatures.end() != aInfo )
 339             return aInfo->second.bCachedState;
 340
 341         return false;
 342     }
 343
 344     //------------------------------------------------------------------
 345     bool OFormNavigationHelper::getBooleanState( sal_Int32 _nFeatureId ) const
 346     {
 347         sal_Bool bState = sal_False;
 348
 349         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 350         if ( m_aSupportedFeatures.end() != aInfo )
 351             aInfo->second.aCachedAdditionalState >>= bState;
 352
 353         return (bool)bState;
 354     }
 355
 356     //------------------------------------------------------------------
 357     ::rtl::OUString OFormNavigationHelper::getStringState( sal_Int32 _nFeatureId ) const
 358     {
 359         ::rtl::OUString sState;
 360
 361         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 362         if ( m_aSupportedFeatures.end() != aInfo )
 363             aInfo->second.aCachedAdditionalState >>= sState;
 364
 365         return sState;
 366     }
 367
 368     //------------------------------------------------------------------
 369     sal_Int32 OFormNavigationHelper::getIntegerState( sal_Int32 _nFeatureId ) const
 370     {
 371         sal_Int32 nState = 0;
 372
 373         FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
 374         if ( m_aSupportedFeatures.end() != aInfo )
 375             aInfo->second.aCachedAdditionalState >>= nState;
 376
 377         return nState;
 378     }
 379
 380     //------------------------------------------------------------------
 381     void OFormNavigationHelper::invalidateSupportedFeaturesSet()
 382     {
 383         disconnectDispatchers( );
 384         // no supported features anymore:
 385     FeatureMap aEmpty;
 386         m_aSupportedFeatures.swap( aEmpty );
 387     }
 388
 389     //==================================================================
 390     //= OFormNavigationMapper
 391     //==================================================================
 392     //------------------------------------------------------------------
 393     OFormNavigationMapper::OFormNavigationMapper( const Reference< XMultiServiceFactory >& _rxORB )
 394     {
 395         m_pUrlTransformer.reset( new UrlTransformer( _rxORB ) );
 396     }
 397
 398     //------------------------------------------------------------------
 399     OFormNavigationMapper::~OFormNavigationMapper( )
 400     {
 401     }
 402
 403     //------------------------------------------------------------------
 404     bool OFormNavigationMapper::getFeatureURL( sal_Int32 _nFeatureId, URL& /* [out] */ _rURL )
 405     {
 406         // get the ascii version of the URL
 407         const char* pAsciiURL = getFeatureURLAscii( _nFeatureId );
 408         if ( pAsciiURL )
 409             _rURL = m_pUrlTransformer->getStrictURLFromAscii( pAsciiURL );
 410
 411         return ( pAsciiURL != NULL );
 412     }
 413
 414     //------------------------------------------------------------------
 415     const char* OFormNavigationMapper::getFeatureURLAscii( sal_Int32 _nFeatureId )
 416     {
 417         const char* pAsciiURL = NULL;
 418
 419         switch ( _nFeatureId )
 420         {
 421         case SID_FM_RECORD_ABSOLUTE     : pAsciiURL = URL_FORM_POSITION;     break;
 422         case SID_FM_RECORD_TOTAL        : pAsciiURL = URL_FORM_RECORDCOUNT;  break;
 423         case SID_FM_RECORD_FIRST        : pAsciiURL = URL_RECORD_FIRST;      break;
 424         case SID_FM_RECORD_PREV         : pAsciiURL = URL_RECORD_PREV;       break;
 425         case SID_FM_RECORD_NEXT         : pAsciiURL = URL_RECORD_NEXT;       break;
 426         case SID_FM_RECORD_LAST         : pAsciiURL = URL_RECORD_LAST;       break;
 427         case SID_FM_RECORD_SAVE         : pAsciiURL = URL_RECORD_SAVE;       break;
 428         case SID_FM_RECORD_UNDO         : pAsciiURL = URL_RECORD_UNDO;       break;
 429         case SID_FM_RECORD_NEW          : pAsciiURL = URL_RECORD_NEW;        break;
 430         case SID_FM_RECORD_DELETE       : pAsciiURL = URL_RECORD_DELETE;     break;
 431         case SID_FM_REFRESH             : pAsciiURL = URL_FORM_REFRESH;      break;
 432         case SID_FM_REFRESH_FORM_CONTROL: pAsciiURL = URL_FORM_REFRESH_CURRENT_CONTROL; break;
 433
 434         case SID_FM_SORTUP             : pAsciiURL = URL_FORM_SORT_UP;       break;
 435         case SID_FM_SORTDOWN           : pAsciiURL = URL_FORM_SORT_DOWN;     break;
 436         case SID_FM_ORDERCRIT          : pAsciiURL = URL_FORM_SORT;          break;
 437         case SID_FM_AUTOFILTER         : pAsciiURL = URL_FORM_AUTO_FILTER;   break;
 438         case SID_FM_FILTERCRIT         : pAsciiURL = URL_FORM_FILTER;        break;
 439         case SID_FM_FORM_FILTERED      : pAsciiURL = URL_FORM_APPLY_FILTER;  break;
 440         case SID_FM_REMOVE_FILTER_SORT : pAsciiURL = URL_FORM_REMOVE_FILTER; break;
 441         };
 442         return pAsciiURL;
 443     }
 444
 445     //------------------------------------------------------------------
 446     sal_Int32 OFormNavigationMapper::getFeatureId( const ::rtl::OUString& _rCompleteURL )
 447     {
 448         sal_Int32 nFeatureId = -1;
 449
 450         if ( _rCompleteURL == URL_FORM_POSITION )
 451             nFeatureId = SID_FM_RECORD_ABSOLUTE;
 452         else if ( _rCompleteURL == URL_FORM_RECORDCOUNT )
 453             nFeatureId = SID_FM_RECORD_TOTAL;
 454         else if ( _rCompleteURL == URL_RECORD_FIRST )
 455             nFeatureId = SID_FM_RECORD_FIRST;
 456         else if ( _rCompleteURL == URL_RECORD_PREV )
 457             nFeatureId = SID_FM_RECORD_PREV;
 458         else if ( _rCompleteURL == URL_RECORD_NEXT )
 459             nFeatureId = SID_FM_RECORD_NEXT;
 460         else if ( _rCompleteURL == URL_RECORD_LAST )
 461             nFeatureId = SID_FM_RECORD_LAST;
 462         else if ( _rCompleteURL == URL_RECORD_SAVE )
 463             nFeatureId = SID_FM_RECORD_SAVE;
 464         else if ( _rCompleteURL == URL_RECORD_UNDO )
 465             nFeatureId = SID_FM_RECORD_UNDO;
 466         else if ( _rCompleteURL == URL_RECORD_NEW )
 467             nFeatureId = SID_FM_RECORD_NEW;
 468         else if ( _rCompleteURL == URL_RECORD_DELETE )
 469             nFeatureId = SID_FM_RECORD_DELETE;
 470         else if ( _rCompleteURL == URL_FORM_REFRESH )
 471             nFeatureId = SID_FM_REFRESH;
 472         else if ( _rCompleteURL == URL_FORM_REFRESH_CURRENT_CONTROL )
 473             nFeatureId = SID_FM_REFRESH_FORM_CONTROL;
 474         else if ( _rCompleteURL == URL_FORM_SORT_UP )
 475             nFeatureId = SID_FM_SORTUP;
 476         else if ( _rCompleteURL == URL_FORM_SORT_DOWN )
 477             nFeatureId = SID_FM_SORTDOWN;
 478         else if ( _rCompleteURL == URL_FORM_SORT )
 479             nFeatureId = SID_FM_ORDERCRIT;
 480         else if ( _rCompleteURL == URL_FORM_AUTO_FILTER )
 481             nFeatureId = SID_FM_AUTOFILTER;
 482         else if ( _rCompleteURL == URL_FORM_FILTER )
 483             nFeatureId = SID_FM_FILTERCRIT;
 484         else if ( _rCompleteURL == URL_FORM_APPLY_FILTER )
 485             nFeatureId = SID_FM_FORM_FILTERED;
 486         else if ( _rCompleteURL == URL_FORM_REMOVE_FILTER )
 487             nFeatureId = SID_FM_REMOVE_FILTER_SORT;
 488
 489         DBG_ASSERT( ( -1 == nFeatureId ) || _rCompleteURL.equalsAscii( getFeatureURLAscii( nFeatureId ) ),
 490             "OFormNavigationMapper::getFeatureId: inconsistent maps!" );
 491
 492         return nFeatureId;
 493     }
 494
 495 //.........................................................................
 496 }   // namespace frm
 497 //.........................................................................