INTEGRATION: CWS odbmacros2 (1.1.2); FILE ADDED

2008/01/02 20:27:38 fs 1.1.2.7: #i49133# don't rely on frame notifications for activity: window events seem to be more reliable
2007/12/22 13:35:53 fs 1.1.2.6: #i49133# just learned that the ActiveFrame attribute of a frames collection is maintained by the framework itself, no need to update it manually
2007/12/20 10:19:28 fs 1.1.2.5: #i49133# never reset the CurrentComponent to NULL. Even upon deactivation, it stays untouched, until another component is activated and sets it to itself. / #i84767# set the parent frame's active frame
2007/12/19 15:04:22 fs 1.1.2.4: comment corrected
2007/12/19 11:29:40 fs 1.1.2.3: thread safety
2007/12/18 21:24:51 fs 1.1.2.2: #i49133# set the XController as CurrentComponent (i.e. AppBasic's ThisComponent) if it has no model
2007/12/13 11:20:32 fs 1.1.2.1: encapsultaing the frame which a controller is attached to

1 files changed, 386 insertions, 0 deletions

diff --git a/dbaccess/source/ui/misc/controllerframe.cxx b/dbaccess/source/ui/misc/controllerframe.cxx
new file mode 100644
index 000000000000..ee5d125e80f7
--- /dev/null
+++ b/dbaccess/source/ui/misc/controllerframe.cxx
@@ -0,0 +1,386 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: controllerframe.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2008-03-06 18:28:21 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#include "controllerframe.hxx"
+#include "IController.hxx"
+
+/** === begin UNO includes === **/
+#include <com/sun/star/sdb/XOfficeDatabaseDocument.hpp>
+#include <com/sun/star/awt/XTopWindow.hpp>
+#include <com/sun/star/awt/XWindow2.hpp>
+#include <com/sun/star/lang/DisposedException.hpp>
+/** === end UNO includes === **/
+
+#include <cppuhelper/implbase1.hxx>
+#include <rtl/ref.hxx>
+#include <sfx2/objsh.hxx>
+#include <tools/diagnose_ex.h>
+
+//........................................................................
+namespace dbaui
+{
+//........................................................................
+
+    /** === begin UNO using === **/
+    using ::com::sun::star::uno::Reference;
+    using ::com::sun::star::uno::XInterface;
+    using ::com::sun::star::uno::UNO_QUERY;
+    using ::com::sun::star::uno::UNO_QUERY_THROW;
+    using ::com::sun::star::uno::UNO_SET_THROW;
+    using ::com::sun::star::uno::Exception;
+    using ::com::sun::star::uno::RuntimeException;
+    using ::com::sun::star::uno::Any;
+    using ::com::sun::star::uno::makeAny;
+    using ::com::sun::star::frame::XFrame;
+    using ::com::sun::star::frame::FrameAction;
+    using ::com::sun::star::frame::FrameAction_FRAME_ACTIVATED;
+    using ::com::sun::star::frame::FrameAction_FRAME_UI_ACTIVATED;
+    using ::com::sun::star::frame::FrameAction_FRAME_DEACTIVATING;
+    using ::com::sun::star::frame::FrameAction_FRAME_UI_DEACTIVATING;
+    using ::com::sun::star::frame::XModel;
+    using ::com::sun::star::frame::XController;
+    using ::com::sun::star::frame::XFramesSupplier;
+    using ::com::sun::star::sdb::XOfficeDatabaseDocument;
+    using ::com::sun::star::awt::XTopWindow;
+    using ::com::sun::star::awt::XTopWindowListener;
+    using ::com::sun::star::awt::XWindow2;
+    using ::com::sun::star::lang::DisposedException;
+    using ::com::sun::star::lang::EventObject;
+    /** === end UNO using === **/
+
+    //====================================================================
+    //= FrameWindowActivationListener
+    //====================================================================
+    typedef ::cppu::WeakImplHelper1 <   XTopWindowListener
+                                    >   FrameWindowActivationListener_Base;
+    class FrameWindowActivationListener : public FrameWindowActivationListener_Base
+    {
+    public:
+        FrameWindowActivationListener( ControllerFrame_Data& _rData );
+
+        void dispose();
+
+    protected:
+        ~FrameWindowActivationListener();
+
+        // XTopWindowListener
+        virtual void SAL_CALL windowOpened( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowClosing( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowClosed( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowMinimized( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowNormalized( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowActivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void SAL_CALL windowDeactivated( const ::com::sun::star::lang::EventObject& e ) throw (::com::sun::star::uno::RuntimeException);
+
+        // XEventListener
+        virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException);
+
+    private:
+        void impl_checkDisposed_throw() const;
+        void impl_actOnFrameWindow_nothrow( bool _bRegister );
+
+    private:
+        ControllerFrame_Data*   m_pData;
+    };
+
+    //====================================================================
+    //= ControllerFrame_Data
+    //====================================================================
+    struct ControllerFrame_Data
+    {
+        ControllerFrame_Data( IController& _rController )
+            :m_rController( _rController )
+            ,m_xFrame()
+            ,m_pListener()
+            ,m_bActive( false )
+        {
+        }
+
+        IController&                                        m_rController;
+        Reference< XFrame >                                 m_xFrame;
+        ::rtl::Reference< FrameWindowActivationListener >   m_pListener;
+        bool                                                m_bActive;
+    };
+
+    //====================================================================
+    //= helper
+    //====================================================================
+    //--------------------------------------------------------------------
+    static void lcl_setFrame_nothrow( ControllerFrame_Data& _rData, const Reference< XFrame >& _rxFrame )
+    {
+        // release old listener
+        if ( _rData.m_pListener.get() )
+        {
+            _rData.m_pListener->dispose();
+            _rData.m_pListener = NULL;
+        }
+        // remember new frame
+        _rData.m_xFrame = _rxFrame;
+        // create new listener
+        if ( _rData.m_xFrame.is() )
+            _rData.m_pListener = new FrameWindowActivationListener( _rData );
+    }
+
+    //--------------------------------------------------------------------
+    static bool lcl_isActive_nothrow( const Reference< XFrame >& _rxFrame )
+    {
+        bool bIsActive = false;
+        try
+        {
+            if ( _rxFrame.is() )
+            {
+                Reference< XWindow2 > xWindow( _rxFrame->getContainerWindow(), UNO_QUERY_THROW );
+                bIsActive = xWindow->isActive();
+            }
+
+        }
+        catch( const Exception& )
+        {
+            DBG_UNHANDLED_EXCEPTION();
+        }
+        return bIsActive;
+    }
+
+    //--------------------------------------------------------------------
+    /** updates various global and local states with a new active component
+
+        In particular, the following are updated
+            * the global working document (aka Basic's ThisComponent in the application
+            Basic), with our controller's model, or the controller itself if there is no such
+            model.
+    */
+    static void lcl_updateActiveComponents_nothrow( const ControllerFrame_Data& _rData )
+    {
+        try
+        {
+            Reference< XController > xCompController( _rData.m_rController.getXController() );
+            OSL_ENSURE( xCompController.is(), "lcl_updateActiveComponents_nothrow: can't do anything without a controller!" );
+            if ( !xCompController.is() )
+                return;
+
+            if ( _rData.m_bActive )
+            {
+                // set the "current component" at the SfxObjectShell
+                Reference< XModel > xModel( xCompController->getModel() );
+                Reference< XInterface > xCurrentComponent;
+                if ( xModel.is() )
+                    xCurrentComponent = xModel;
+                else
+                    xCurrentComponent = xCompController;
+                SfxObjectShell::SetCurrentComponent( xCurrentComponent );
+            }
+        }
+        catch( const Exception& )
+        {
+            DBG_UNHANDLED_EXCEPTION();
+        }
+    }
+
+    //--------------------------------------------------------------------
+    static void lcl_updateActive_nothrow( ControllerFrame_Data& _rData, bool _bActive )
+    {
+        if ( _rData.m_bActive == _bActive )
+            return;
+        _rData.m_bActive = _bActive;
+
+        lcl_updateActiveComponents_nothrow( _rData );
+    }
+
+    //--------------------------------------------------------------------
+    FrameWindowActivationListener::FrameWindowActivationListener( ControllerFrame_Data& _rData )
+        :m_pData( &_rData )
+    {
+        impl_actOnFrameWindow_nothrow( true );
+    }
+
+    //--------------------------------------------------------------------
+    FrameWindowActivationListener::~FrameWindowActivationListener()
+    {
+    }
+
+    //--------------------------------------------------------------------
+    void FrameWindowActivationListener::dispose()
+    {
+        impl_actOnFrameWindow_nothrow( false );
+        m_pData = NULL;
+    }
+
+    //--------------------------------------------------------------------
+    void FrameWindowActivationListener::impl_actOnFrameWindow_nothrow( bool _bRegister )
+    {
+        OSL_ENSURE( m_pData && m_pData->m_xFrame.is(), "FrameWindowActivationListener::impl_actOnFrameWindow_nothrow: no frame!" );
+        if ( !m_pData || !m_pData->m_xFrame.is() )
+            return;
+
+        try
+        {
+            void ( SAL_CALL XTopWindow::*pListenerAction )( const Reference< XTopWindowListener >& ) =
+                _bRegister ? &XTopWindow::addTopWindowListener : &XTopWindow::removeTopWindowListener;
+
+            Reference< XTopWindow > xFrameContainer( m_pData->m_xFrame->getContainerWindow(), UNO_QUERY_THROW );
+            (xFrameContainer.get()->*pListenerAction)( this );
+        }
+        catch( const Exception& )
+        {
+            DBG_UNHANDLED_EXCEPTION();
+        }
+    }
+
+    //--------------------------------------------------------------------
+    void FrameWindowActivationListener::impl_checkDisposed_throw() const
+    {
+        if ( !m_pData )
+            throw DisposedException( ::rtl::OUString(), *const_cast< FrameWindowActivationListener* >( this ) );
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowOpened( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        // not interested in
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowClosing( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        // not interested in
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowClosed( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        // not interested in
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowMinimized( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        // not interested in
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowNormalized( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        // not interested in
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowActivated( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        impl_checkDisposed_throw();
+        lcl_updateActive_nothrow( *m_pData, true );
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::windowDeactivated( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        impl_checkDisposed_throw();
+        lcl_updateActive_nothrow( *m_pData, false );
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL FrameWindowActivationListener::disposing( const EventObject& /*_rEvent*/ ) throw (RuntimeException)
+    {
+        dispose();
+    }
+
+    //====================================================================
+    //= ControllerFrame
+    //====================================================================
+    //--------------------------------------------------------------------
+    ControllerFrame::ControllerFrame( IController& _rController )
+        :m_pData( new ControllerFrame_Data( _rController ) )
+    {
+    }
+
+    //--------------------------------------------------------------------
+    ControllerFrame::~ControllerFrame()
+    {
+    }
+
+    //--------------------------------------------------------------------
+    const Reference< XFrame >& ControllerFrame::attachFrame( const Reference< XFrame >& _rxFrame )
+    {
+        // set new frame, including listener handling
+        lcl_setFrame_nothrow( *m_pData, _rxFrame );
+
+        // determine whether we're active
+        m_pData->m_bActive = lcl_isActive_nothrow( m_pData->m_xFrame );
+
+        // update active component
+        if ( m_pData->m_bActive )
+            lcl_updateActiveComponents_nothrow( *m_pData );
+
+        return m_pData->m_xFrame;
+    }
+
+    //--------------------------------------------------------------------
+    const Reference< XFrame >& ControllerFrame::getFrame() const
+    {
+        return m_pData->m_xFrame;
+    }
+
+    //--------------------------------------------------------------------
+    bool ControllerFrame::isActive() const
+    {
+        return m_pData->m_bActive;
+    }
+
+    //--------------------------------------------------------------------
+    void ControllerFrame::frameAction( FrameAction _eAction )
+    {
+        bool bActive = m_pData->m_bActive;
+
+        switch ( _eAction )
+        {
+            case FrameAction_FRAME_ACTIVATED:
+            case FrameAction_FRAME_UI_ACTIVATED:
+                bActive = true;
+                break;
+
+            case FrameAction_FRAME_DEACTIVATING:
+            case FrameAction_FRAME_UI_DEACTIVATING:
+                bActive = false;
+                break;
+
+            default:
+                break;
+        }
+
+        lcl_updateActive_nothrow( *m_pData, bActive );
+    }
+
+//........................................................................
+} // namespace dbaui
+//........................................................................