forms/source/component/Button.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: Button.cxx,v $
  10  * $Revision: 1.22 $
  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
  34 #include "Button.hxx"
  35
  36 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  37
  38 #include <comphelper/streamsection.hxx>
  39 #include <comphelper/basicio.hxx>
  40 #include <tools/diagnose_ex.h>
  41 #include <tools/debug.hxx>
  42 #include <tools/urlobj.hxx>
  43 #include <vcl/svapp.hxx>
  44 #include <vos/mutex.hxx>
  45
  46 //.........................................................................
  47 namespace frm
  48 {
  49 //.........................................................................
  50
  51 using namespace ::com::sun::star::uno;
  52 using namespace ::com::sun::star::sdb;
  53 using namespace ::com::sun::star::sdbc;
  54 using namespace ::com::sun::star::sdbcx;
  55 using namespace ::com::sun::star::beans;
  56 using namespace ::com::sun::star::container;
  57 using namespace ::com::sun::star::form;
  58 using namespace ::com::sun::star::awt;
  59 using namespace ::com::sun::star::io;
  60 using namespace ::com::sun::star::lang;
  61 using namespace ::com::sun::star::util;
  62 using ::com::sun::star::frame::XDispatchProviderInterceptor;
  63
  64 //==================================================================
  65 //= OButtonModel
  66 //==================================================================
  67 DBG_NAME(OButtonModel)
  68 //------------------------------------------------------------------
  69 InterfaceRef SAL_CALL OButtonModel_CreateInstance(const Reference<XMultiServiceFactory>& _rxFactory)
  70 {
  71     return *(new OButtonModel(_rxFactory));
  72 }
  73
  74 //------------------------------------------------------------------
  75 OButtonModel::OButtonModel(const Reference<XMultiServiceFactory>& _rxFactory)
  76     :OClickableImageBaseModel( _rxFactory, VCL_CONTROLMODEL_COMMANDBUTTON, FRM_SUN_CONTROL_COMMANDBUTTON )
  77                                     // use the old control name for compatibility reasons
  78     ,m_aResetHelper( *this, m_aMutex )
  79     ,m_eDefaultState( STATE_NOCHECK )
  80 {
  81     DBG_CTOR( OButtonModel, NULL );
  82     m_nClassId = FormComponentType::COMMANDBUTTON;
  83 }
  84
  85 //------------------------------------------------------------------
  86 Any SAL_CALL OButtonModel::queryAggregation( const Type& _type ) throw(RuntimeException)
  87 {
  88     Any aReturn = OClickableImageBaseModel::queryAggregation( _type );
  89     if ( !aReturn.hasValue() )
  90         aReturn = OButtonModel_Base::queryInterface( _type );
  91     return aReturn;
  92 }
  93
  94 //------------------------------------------------------------------
  95 Sequence< Type > OButtonModel::_getTypes()
  96 {
  97     return ::comphelper::concatSequences(
  98         OClickableImageBaseModel::_getTypes(),
  99         OButtonModel_Base::getTypes()
 100     );
 101 }
 102
 103 //------------------------------------------------------------------
 104 OButtonModel::OButtonModel( const OButtonModel* _pOriginal, const Reference<XMultiServiceFactory>& _rxFactory )
 105     :OClickableImageBaseModel( _pOriginal, _rxFactory )
 106     ,m_aResetHelper( *this, m_aMutex )
 107     ,m_eDefaultState( _pOriginal->m_eDefaultState )
 108 {
 109     DBG_CTOR( OButtonModel, NULL );
 110     m_nClassId = FormComponentType::COMMANDBUTTON;
 111
 112     implInitializeImageURL();
 113 }
 114
 115 //------------------------------------------------------------------------------
 116 OButtonModel::~OButtonModel()
 117 {
 118     DBG_DTOR(OButtonModel, NULL);
 119 }
 120
 121 //------------------------------------------------------------------------------
 122 void OButtonModel::describeFixedProperties( Sequence< Property >& _rProps ) const
 123 {
 124     BEGIN_DESCRIBE_PROPERTIES( 6, OClickableImageBaseModel )
 125         DECL_PROP1( BUTTONTYPE,                 FormButtonType,                         BOUND );
 126         DECL_PROP1( DEFAULT_STATE,          sal_Int16,                  BOUND );
 127         DECL_PROP1( DISPATCHURLINTERNAL,        sal_Bool,                                   BOUND );
 128         DECL_PROP1( TARGET_URL,                 ::rtl::OUString,                        BOUND );
 129         DECL_PROP1( TARGET_FRAME,               ::rtl::OUString,                        BOUND );
 130         DECL_PROP1( TABINDEX,                   sal_Int16,                                      BOUND );
 131     END_DESCRIBE_PROPERTIES();
 132 }
 133
 134 //------------------------------------------------------------------------------
 135 IMPLEMENT_DEFAULT_CLONING( OButtonModel )
 136
 137 // XServiceInfo
 138 //------------------------------------------------------------------------------
 139 StringSequence  OButtonModel::getSupportedServiceNames() throw()
 140 {
 141     StringSequence aSupported = OClickableImageBaseModel::getSupportedServiceNames();
 142     aSupported.realloc( aSupported.getLength() + 1 );
 143
 144     ::rtl::OUString* pArray = aSupported.getArray();
 145     pArray[ aSupported.getLength() - 1 ] = FRM_SUN_COMPONENT_COMMANDBUTTON;
 146
 147     return aSupported;
 148 }
 149
 150 //------------------------------------------------------------------------------
 151 ::rtl::OUString OButtonModel::getServiceName() throw ( ::com::sun::star::uno::RuntimeException)
 152 {
 153     return FRM_COMPONENT_COMMANDBUTTON; // old (non-sun) name for compatibility !
 154 }
 155
 156 //------------------------------------------------------------------------------
 157 void OButtonModel::write(const Reference<XObjectOutputStream>& _rxOutStream) throw (::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException)
 158 {
 159     OClickableImageBaseModel::write(_rxOutStream);
 160
 161     _rxOutStream->writeShort(0x0003);   // Version
 162
 163     {
 164         OStreamSection aSection( _rxOutStream.get() );
 165             // this will allow readers to skip unknown bytes in their dtor
 166
 167         _rxOutStream->writeShort( (sal_uInt16)m_eButtonType );
 168
 169         ::rtl::OUString sTmp = INetURLObject::decode( m_sTargetURL, '%', INetURLObject::DECODE_UNAMBIGUOUS);
 170         _rxOutStream << sTmp;
 171         _rxOutStream << m_sTargetFrame;
 172         writeHelpTextCompatibly(_rxOutStream);
 173         _rxOutStream << isDispatchUrlInternal();
 174     }
 175 }
 176
 177 //------------------------------------------------------------------------------
 178 void OButtonModel::read(const Reference<XObjectInputStream>& _rxInStream) throw (::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException)
 179 {
 180     OClickableImageBaseModel::read(_rxInStream);
 181
 182     sal_uInt16 nVersion = _rxInStream->readShort();     // Version
 183     switch (nVersion)
 184     {
 185         case 0x0001:
 186         {
 187             m_eButtonType = (FormButtonType)_rxInStream->readShort();
 188
 189             _rxInStream >> m_sTargetURL;
 190             _rxInStream >> m_sTargetFrame;
 191         }
 192         break;
 193
 194         case 0x0002:
 195         {
 196             m_eButtonType = (FormButtonType)_rxInStream->readShort();
 197
 198             _rxInStream >> m_sTargetURL;
 199             _rxInStream >> m_sTargetFrame;
 200             readHelpTextCompatibly(_rxInStream);
 201         }
 202         break;
 203
 204         case 0x0003:
 205         {
 206             OStreamSection aSection( _rxInStream.get() );
 207                 // this will skip any unknown bytes in it's dtor
 208
 209             // button type
 210             m_eButtonType = (FormButtonType)_rxInStream->readShort();
 211
 212             // URL
 213             _rxInStream >> m_sTargetURL;
 214
 215             // target frame
 216             _rxInStream >> m_sTargetFrame;
 217
 218             // help text
 219             readHelpTextCompatibly(_rxInStream);
 220
 221             // DispatchInternal
 222             sal_Bool bDispath;
 223             _rxInStream >> bDispath;
 224             setDispatchUrlInternal(bDispath);
 225         }
 226         break;
 227
 228         default:
 229             DBG_ERROR("OButtonModel::read : unknown version !");
 230             m_eButtonType = FormButtonType_PUSH;
 231             m_sTargetURL = ::rtl::OUString();
 232             m_sTargetFrame = ::rtl::OUString();
 233             break;
 234     }
 235 }
 236
 237 //--------------------------------------------------------------------
 238 void SAL_CALL OButtonModel::disposing()
 239 {
 240     m_aResetHelper.disposing();
 241     OClickableImageBaseModel::disposing();
 242 }
 243
 244 //--------------------------------------------------------------------
 245 void SAL_CALL OButtonModel::reset() throw (RuntimeException)
 246 {
 247     if ( !m_aResetHelper.approveReset() )
 248         return;
 249
 250     impl_resetNoBroadcast_nothrow();
 251
 252     m_aResetHelper.notifyResetted();
 253 }
 254
 255 //--------------------------------------------------------------------
 256 void SAL_CALL OButtonModel::addResetListener( const Reference< XResetListener >& _listener ) throw (RuntimeException)
 257 {
 258     m_aResetHelper.addResetListener( _listener );
 259 }
 260
 261 //--------------------------------------------------------------------
 262 void SAL_CALL OButtonModel::removeResetListener( const Reference< XResetListener >& _listener ) throw (RuntimeException)
 263 {
 264     m_aResetHelper.removeResetListener( _listener );
 265 }
 266
 267 //--------------------------------------------------------------------
 268 void SAL_CALL OButtonModel::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
 269 {
 270     switch ( _nHandle )
 271     {
 272     case PROPERTY_ID_DEFAULT_STATE:
 273         _rValue <<= (sal_Int16)m_eDefaultState;
 274         break;
 275
 276     default:
 277         OClickableImageBaseModel::getFastPropertyValue( _rValue, _nHandle );
 278         break;
 279     }
 280 }
 281
 282 //--------------------------------------------------------------------
 283 void SAL_CALL OButtonModel::setFastPropertyValue_NoBroadcast( sal_Int32 _nHandle, const Any& _rValue ) throw (Exception)
 284 {
 285     switch ( _nHandle )
 286     {
 287     case PROPERTY_ID_DEFAULT_STATE:
 288     {
 289         sal_Int16 nDefaultState( (sal_Int16)STATE_NOCHECK );
 290         OSL_VERIFY( _rValue >>= nDefaultState );
 291         m_eDefaultState = (ToggleState)nDefaultState;
 292         impl_resetNoBroadcast_nothrow();
 293     }
 294     break;
 295
 296     default:
 297         OClickableImageBaseModel::setFastPropertyValue_NoBroadcast( _nHandle, _rValue );
 298         break;
 299     }
 300 }
 301
 302 //--------------------------------------------------------------------
 303 sal_Bool SAL_CALL OButtonModel::convertFastPropertyValue( Any& _rConvertedValue, Any& _rOldValue, sal_Int32 _nHandle, const Any& _rValue ) throw (IllegalArgumentException)
 304 {
 305     sal_Bool bModified = sal_False;
 306     switch ( _nHandle )
 307     {
 308     case PROPERTY_ID_DEFAULT_STATE:
 309         bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, (sal_Int16)m_eDefaultState );
 310         break;
 311
 312     default:
 313         bModified = OClickableImageBaseModel::convertFastPropertyValue( _rConvertedValue, _rOldValue, _nHandle, _rValue );
 314         break;
 315     }
 316     return bModified;
 317 }
 318
 319 //--------------------------------------------------------------------
 320 Any OButtonModel::getPropertyDefaultByHandle( sal_Int32 _nHandle ) const
 321 {
 322     Any aDefault;
 323     switch ( _nHandle )
 324     {
 325     case PROPERTY_ID_DEFAULT_STATE:
 326         aDefault <<= (sal_Int16)STATE_NOCHECK;
 327         break;
 328
 329     default:
 330         aDefault = OClickableImageBaseModel::getPropertyDefaultByHandle( _nHandle );
 331         break;
 332     }
 333     return aDefault;
 334 }
 335
 336 //--------------------------------------------------------------------
 337 void OButtonModel::impl_resetNoBroadcast_nothrow()
 338 {
 339     try
 340     {
 341         setPropertyValue( PROPERTY_STATE, getPropertyValue( PROPERTY_DEFAULT_STATE ) );
 342     }
 343     catch( const Exception& )
 344     {
 345         DBG_UNHANDLED_EXCEPTION();
 346     }
 347 }
 348
 349 //==================================================================
 350 // OButtonControl
 351 //==================================================================
 352 //------------------------------------------------------------------
 353 InterfaceRef SAL_CALL OButtonControl_CreateInstance(const Reference<XMultiServiceFactory>& _rxFactory)
 354 {
 355     return *(new OButtonControl(_rxFactory));
 356 }
 357
 358 //------------------------------------------------------------------------------
 359 Sequence<Type> OButtonControl::_getTypes()
 360 {
 361     return ::comphelper::concatSequences(
 362         OButtonControl_BASE::getTypes(),
 363         OClickableImageBaseControl::_getTypes(),
 364         OFormNavigationHelper::getTypes()
 365     );
 366 }
 367
 368 //------------------------------------------------------------------------------
 369 StringSequence  OButtonControl::getSupportedServiceNames() throw()
 370 {
 371     StringSequence aSupported = OClickableImageBaseControl::getSupportedServiceNames();
 372     aSupported.realloc(aSupported.getLength() + 1);
 373
 374     ::rtl::OUString*pArray = aSupported.getArray();
 375     pArray[aSupported.getLength()-1] = FRM_SUN_CONTROL_COMMANDBUTTON;
 376     return aSupported;
 377 }
 378
 379 //------------------------------------------------------------------------------
 380 OButtonControl::OButtonControl(const Reference<XMultiServiceFactory>& _rxFactory)
 381                  :OClickableImageBaseControl(_rxFactory, VCL_CONTROL_COMMANDBUTTON)
 382                  ,OFormNavigationHelper( _rxFactory )
 383                  ,m_nClickEvent( 0 )
 384                  ,m_nTargetUrlFeatureId( -1 )
 385                  ,m_bEnabledByPropertyValue( sal_False )
 386 {
 387     increment(m_refCount);
 388     {
 389         // als ActionListener anmelden
 390         Reference<XButton>  xButton;
 391         query_aggregation( m_xAggregate, xButton);
 392         if (xButton.is())
 393             xButton->addActionListener(this);
 394     }
 395     // Refcount bei 1 fuer Listener
 396     decrement(m_refCount);
 397 }
 398
 399 //------------------------------------------------------------------------------
 400 OButtonControl::~OButtonControl()
 401 {
 402     if (m_nClickEvent)
 403         Application::RemoveUserEvent(m_nClickEvent);
 404 }
 405
 406 // UNO Anbindung
 407 //------------------------------------------------------------------------------
 408 Any SAL_CALL OButtonControl::queryAggregation(const Type& _rType) throw (RuntimeException)
 409 {
 410     // if asked for the XTypeProvider, don't let OButtonControl_BASE do this
 411     Any aReturn;
 412     if ( !_rType.equals( ::getCppuType( static_cast< Reference< XTypeProvider >* >( NULL ) ) ) )
 413         aReturn = OButtonControl_BASE::queryInterface( _rType );
 414
 415     if ( !aReturn.hasValue() )
 416         aReturn = OClickableImageBaseControl::queryAggregation( _rType );
 417
 418     if ( !aReturn.hasValue() )
 419         aReturn = OFormNavigationHelper::queryInterface( _rType );
 420
 421     return aReturn;
 422 }
 423
 424 //------------------------------------------------------------------------------
 425 void SAL_CALL OButtonControl::disposing()
 426 {
 427     startOrStopModelPropertyListening( false );
 428
 429     OClickableImageBaseControl::disposing();
 430     OFormNavigationHelper::dispose();
 431 }
 432
 433 //------------------------------------------------------------------------------
 434 void SAL_CALL OButtonControl::disposing( const EventObject& _rSource ) throw( RuntimeException )
 435 {
 436     OControl::disposing( _rSource );
 437     OFormNavigationHelper::disposing( _rSource );
 438 }
 439
 440 // ActionListener
 441 //------------------------------------------------------------------------------
 442 void OButtonControl::actionPerformed(const ActionEvent& /*rEvent*/) throw ( ::com::sun::star::uno::RuntimeException)
 443 {
 444     // Asynchron fuer starutil::URL-Button
 445     sal_uInt32 n = Application::PostUserEvent( LINK(this, OButtonControl,OnClick) );
 446     {
 447         ::osl::MutexGuard aGuard( m_aMutex );
 448         m_nClickEvent = n;
 449     }
 450 }
 451
 452 //------------------------------------------------------------------------------
 453 IMPL_LINK( OButtonControl, OnClick, void*, EMPTYARG )
 454 {
 455     ::osl::ClearableMutexGuard aGuard( m_aMutex );
 456     m_nClickEvent = 0;
 457
 458     if (m_aApproveActionListeners.getLength())
 459     {
 460         // if there are listeners, start the action in an own thread, to not allow
 461         // them to block us here (we're in the application's main thread)
 462         getImageProducerThread()->addEvent();
 463     }
 464     else
 465     {
 466         // Sonst nicht. Dann darf man aber auf keinen Fal die Listener
 467         // benachrichtigen, auch dann nicht, wenn er spaeter hinzukommt.
 468         aGuard.clear();
 469
 470         // recognize the button type
 471         Reference<XPropertySet>  xSet(getModel(), UNO_QUERY);
 472         if (!xSet.is())
 473             return 0L;
 474
 475         if (FormButtonType_PUSH == *(FormButtonType*)xSet->getPropertyValue(PROPERTY_BUTTONTYPE).getValue())
 476         {
 477             // notify the action listeners for a push button
 478             ::cppu::OInterfaceIteratorHelper aIter(m_aActionListeners);
 479             ActionEvent aEvt(static_cast<XWeak*>(this), m_aActionCommand);
 480             while(aIter.hasMoreElements() )
 481             {
 482                 // catch exceptions
 483                 // and catch them on a per-listener basis - if one listener fails, the others still need
 484                 // to get notified
 485                 // 97676 - 21.02.2002 - fs@openoffice.org
 486                 try
 487                 {
 488                     static_cast< XActionListener* >( aIter.next() )->actionPerformed(aEvt);
 489                 }
 490 #ifdef DBG_UTIL
 491                 catch( const RuntimeException& )
 492                 {
 493                     // silent this
 494                 }
 495 #endif
 496                 catch( const Exception& )
 497                 {
 498                     DBG_ERROR( "OButtonControl::OnClick: caught a exception other than RuntimeException!" );
 499                 }
 500             }
 501         }
 502         else
 503             actionPerformed_Impl( sal_False, ::com::sun::star::awt::MouseEvent() );
 504     }
 505     return 0L;
 506 }
 507
 508 //------------------------------------------------------------------------------
 509 void OButtonControl::actionPerformed_Impl( sal_Bool _bNotifyListener, const ::com::sun::star::awt::MouseEvent& _rEvt )
 510 {
 511     {
 512         sal_Int32 nFeatureId = -1;
 513         {
 514             ::osl::MutexGuard aGuard( m_aMutex );
 515             nFeatureId = m_nTargetUrlFeatureId;
 516         }
 517
 518         if ( nFeatureId != -1 )
 519         {
 520             if ( !approveAction() )
 521                 return;
 522
 523             ::vos::OGuard aGuard( Application::GetSolarMutex() );
 524             dispatch( nFeatureId );
 525             return;
 526         }
 527     }
 528
 529     OClickableImageBaseControl::actionPerformed_Impl( _bNotifyListener, _rEvt );
 530 }
 531
 532 // XButton
 533 //------------------------------------------------------------------------------
 534 void OButtonControl::setLabel(const ::rtl::OUString& Label) throw( RuntimeException )
 535 {
 536     Reference<XButton>  xButton;
 537     query_aggregation( m_xAggregate, xButton );
 538     if (xButton.is())
 539         xButton->setLabel(Label);
 540 }
 541
 542 //------------------------------------------------------------------------------
 543 void SAL_CALL OButtonControl::setActionCommand(const ::rtl::OUString& _rCommand) throw( RuntimeException )
 544 {
 545     {
 546         ::osl::MutexGuard aGuard( m_aMutex );
 547         m_aActionCommand = _rCommand;
 548     }
 549
 550     Reference<XButton>  xButton;
 551     query_aggregation( m_xAggregate, xButton);
 552     if (xButton.is())
 553         xButton->setActionCommand(_rCommand);
 554 }
 555
 556 //------------------------------------------------------------------------------
 557 void SAL_CALL OButtonControl::addActionListener(const Reference<XActionListener>& _rxListener) throw( RuntimeException )
 558 {
 559     m_aActionListeners.addInterface(_rxListener);
 560 }
 561
 562 //------------------------------------------------------------------------------
 563 void SAL_CALL OButtonControl::removeActionListener(const Reference<XActionListener>& _rxListener) throw( RuntimeException )
 564 {
 565     m_aActionListeners.removeInterface(_rxListener);
 566 }
 567
 568 //------------------------------------------------------------------------------
 569 class DoPropertyListening
 570 {
 571 private:
 572     Reference< XPropertySet >               m_xProps;
 573     Reference< XPropertyChangeListener >    m_xListener;
 574     bool                                    m_bStartListening;
 575
 576 public:
 577     DoPropertyListening(
 578         const Reference< XInterface >& _rxComponent,
 579         const Reference< XPropertyChangeListener >& _rxListener,
 580         bool _bStart
 581     );
 582
 583     void    handleListening( const ::rtl::OUString& _rPropertyName );
 584 };
 585
 586 //..............................................................................
 587 DoPropertyListening::DoPropertyListening(
 588         const Reference< XInterface >& _rxComponent, const Reference< XPropertyChangeListener >& _rxListener,
 589         bool _bStart )
 590     :m_xProps( _rxComponent, UNO_QUERY )
 591     ,m_xListener( _rxListener )
 592     ,m_bStartListening( _bStart )
 593 {
 594     DBG_ASSERT( m_xProps.is() || !_rxComponent.is(), "DoPropertyListening::DoPropertyListening: valid component, but no property set!" );
 595     DBG_ASSERT( m_xListener.is(), "DoPropertyListening::DoPropertyListening: invalid listener!" );
 596 }
 597
 598 //..............................................................................
 599 void DoPropertyListening::handleListening( const ::rtl::OUString& _rPropertyName )
 600 {
 601     if ( m_xProps.is() )
 602     {
 603         if ( m_bStartListening )
 604             m_xProps->addPropertyChangeListener( _rPropertyName, m_xListener );
 605         else
 606             m_xProps->removePropertyChangeListener( _rPropertyName, m_xListener );
 607     }
 608 }
 609
 610 //------------------------------------------------------------------------------
 611 void OButtonControl::startOrStopModelPropertyListening( bool _bStart )
 612 {
 613     DoPropertyListening aListeningHandler( getModel(), this, _bStart );
 614     aListeningHandler.handleListening( PROPERTY_TARGET_URL );
 615     aListeningHandler.handleListening( PROPERTY_BUTTONTYPE );
 616     aListeningHandler.handleListening( PROPERTY_ENABLED );
 617 }
 618
 619 //------------------------------------------------------------------------------
 620 sal_Bool SAL_CALL OButtonControl::setModel( const Reference< XControlModel >& _rxModel ) throw ( RuntimeException )
 621 {
 622     startOrStopModelPropertyListening( false );
 623     sal_Bool bResult = OClickableImageBaseControl::setModel( _rxModel );
 624     startOrStopModelPropertyListening( true );
 625
 626     m_bEnabledByPropertyValue = sal_True;
 627     Reference< XPropertySet > xModelProps( _rxModel, UNO_QUERY );
 628     if ( xModelProps.is() )
 629         xModelProps->getPropertyValue( PROPERTY_ENABLED ) >>= m_bEnabledByPropertyValue;
 630
 631     modelFeatureUrlPotentiallyChanged( );
 632
 633     return bResult;
 634 }
 635
 636 //------------------------------------------------------------------------------
 637 void OButtonControl::modelFeatureUrlPotentiallyChanged( )
 638 {
 639     sal_Int32 nOldUrlFeatureId = m_nTargetUrlFeatureId;
 640
 641     // doe we have another TargetURL now? If so, we need to update our dispatches
 642     m_nTargetUrlFeatureId = getModelUrlFeatureId( );
 643     if ( nOldUrlFeatureId != m_nTargetUrlFeatureId )
 644     {
 645         invalidateSupportedFeaturesSet();
 646         if ( !isDesignMode() )
 647             updateDispatches( );
 648     }
 649 }
 650
 651 //------------------------------------------------------------------------------
 652 void SAL_CALL OButtonControl::propertyChange( const PropertyChangeEvent& _rEvent ) throw ( RuntimeException )
 653 {
 654     if  (   _rEvent.PropertyName.equals( PROPERTY_TARGET_URL )
 655         ||  _rEvent.PropertyName.equals( PROPERTY_BUTTONTYPE )
 656         )
 657     {
 658         modelFeatureUrlPotentiallyChanged( );
 659     }
 660     else if ( _rEvent.PropertyName.equals( PROPERTY_ENABLED ) )
 661     {
 662         _rEvent.NewValue >>= m_bEnabledByPropertyValue;
 663     }
 664 }
 665
 666 //------------------------------------------------------------------------------
 667 namespace
 668 {
 669     bool isFormControllerURL( const ::rtl::OUString& _rURL )
 670     {
 671         const sal_Int32 nPrefixLen = URL_CONTROLLER_PREFIX.length;
 672         return  ( _rURL.getLength() > nPrefixLen )
 673             &&  ( _rURL.compareToAscii( URL_CONTROLLER_PREFIX, nPrefixLen ) == 0 );
 674     }
 675 }
 676
 677 //------------------------------------------------------------------------------
 678 sal_Int32 OButtonControl::getModelUrlFeatureId( ) const
 679 {
 680     sal_Int32 nFeatureId = -1;
 681
 682     // some URL related properties of the model
 683     ::rtl::OUString sUrl;
 684     FormButtonType eButtonType = FormButtonType_PUSH;
 685
 686     Reference< XPropertySet > xModelProps( const_cast< OButtonControl* >( this )->getModel(), UNO_QUERY );
 687     if ( xModelProps.is() )
 688     {
 689         xModelProps->getPropertyValue( PROPERTY_TARGET_URL ) >>= sUrl;
 690         xModelProps->getPropertyValue( PROPERTY_BUTTONTYPE ) >>= eButtonType;
 691     }
 692
 693     // are we an URL button?
 694     if ( eButtonType == FormButtonType_URL )
 695     {
 696         // is it a feature URL?
 697         if ( isFormControllerURL( sUrl ) )
 698         {
 699             OFormNavigationMapper aMapper( m_aContext.getLegacyServiceFactory() );
 700             nFeatureId = aMapper.getFeatureId( sUrl );
 701         }
 702     }
 703
 704     return nFeatureId;
 705 }
 706
 707 //------------------------------------------------------------------
 708 void SAL_CALL OButtonControl::setDesignMode( sal_Bool _bOn ) throw( RuntimeException )
 709 {
 710     OClickableImageBaseControl::setDesignMode( _bOn  );
 711
 712     if ( _bOn )
 713         disconnectDispatchers();
 714     else
 715         connectDispatchers();
 716         // this will connect if not already connected and just update else
 717 }
 718
 719 //------------------------------------------------------------------------------
 720 void OButtonControl::getSupportedFeatures( ::std::vector< sal_Int32 >& /* [out] */ _rFeatureIds )
 721 {
 722     if ( -1 != m_nTargetUrlFeatureId )
 723         _rFeatureIds.push_back( m_nTargetUrlFeatureId );
 724 }
 725
 726 //------------------------------------------------------------------
 727 void OButtonControl::featureStateChanged( sal_Int32 _nFeatureId, sal_Bool _bEnabled )
 728 {
 729     if ( _nFeatureId == m_nTargetUrlFeatureId )
 730     {
 731         // enable or disable our peer, according to the new state
 732         Reference< XVclWindowPeer > xPeer( getPeer(), UNO_QUERY );
 733         if ( xPeer.is() )
 734             xPeer->setProperty( PROPERTY_ENABLED, makeAny( m_bEnabledByPropertyValue ? _bEnabled : sal_False ) );
 735             // if we're disabled according to our model's property, then
 736             // we don't care for the feature state, but *are* disabled.
 737             // If the model's property states that we're enabled, then we *do*
 738             // care for the feature state
 739     }
 740
 741     // base class
 742     OFormNavigationHelper::featureStateChanged( _nFeatureId, _bEnabled );
 743 }
 744
 745 //------------------------------------------------------------------
 746 void OButtonControl::allFeatureStatesChanged( )
 747 {
 748     if ( -1 != m_nTargetUrlFeatureId )
 749         // we have only one supported feature, so simulate it has changed ...
 750         featureStateChanged( m_nTargetUrlFeatureId, isEnabled( m_nTargetUrlFeatureId ) );
 751
 752     // base class
 753     OFormNavigationHelper::allFeatureStatesChanged( );
 754 }
 755
 756 //------------------------------------------------------------------
 757 bool OButtonControl::isEnabled( sal_Int32 _nFeatureId ) const
 758 {
 759     if ( const_cast< OButtonControl* >( this )->isDesignMode() )
 760         // TODO: the model property?
 761        return true;
 762
 763     return OFormNavigationHelper::isEnabled( _nFeatureId );
 764 }
 765
 766 //--------------------------------------------------------------------
 767 void SAL_CALL OButtonControl::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
 768 {
 769     OClickableImageBaseControl::registerDispatchProviderInterceptor( _rxInterceptor );
 770     OFormNavigationHelper::registerDispatchProviderInterceptor( _rxInterceptor );
 771 }
 772
 773 //--------------------------------------------------------------------
 774 void SAL_CALL OButtonControl::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
 775 {
 776     OClickableImageBaseControl::releaseDispatchProviderInterceptor( _rxInterceptor );
 777     OFormNavigationHelper::releaseDispatchProviderInterceptor( _rxInterceptor );
 778 }
 779
 780 //.........................................................................
 781 }       // namespace frm
 782 //.........................................................................
 783