INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED

2004/07/19 15:18:43 fs 1.1.2.3: during #114856#: properly determine who instigated a setControlValue, so that we can propagate the values to appropriate interested parties / while we were here: make some attributes private ...
2004/06/24 09:55:13 fs 1.1.2.2: #i30674# allow second reference value for check boxes
2004/05/12 08:14:38 fs 1.1.2.1: #116712# base class for comonents supporting a reference value

1 files changed, 338 insertions, 0 deletions

diff --git a/forms/source/component/refvaluecomponent.cxx b/forms/source/component/refvaluecomponent.cxx
new file mode 100644
index 000000000000..067c4a520221
--- /dev/null
+++ b/forms/source/component/refvaluecomponent.cxx
@@ -0,0 +1,338 @@
+/*************************************************************************
+ *
+ *  $RCSfile: refvaluecomponent.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-11-16 10:42:15 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef EFORMS2_FORMS_SOURCE_COMPONENT_REFVALUECOMPONENT_HXX
+#include "refvaluecomponent.hxx"
+#endif
+
+/** === begin UNO includes === **/
+/** === end UNO includes === **/
+
+//........................................................................
+namespace frm
+{
+//........................................................................
+
+    using namespace ::com::sun::star::uno;
+    using namespace ::com::sun::star::lang;
+    using namespace ::com::sun::star::beans;
+    using namespace ::com::sun::star::form::binding;
+
+    //====================================================================
+    //=
+    //====================================================================
+    //--------------------------------------------------------------------
+    OReferenceValueComponent::OReferenceValueComponent( const Reference< XMultiServiceFactory>& _rxFactory, const ::rtl::OUString& _rUnoControlModelTypeName, const ::rtl::OUString& _rDefault, sal_Bool _bSupportNoCheckRefValue )
+        :OBoundControlModel( _rxFactory, _rUnoControlModelTypeName, _rDefault, sal_False, sal_True, sal_True )
+        ,m_eValueExchangeType( eBoolean )
+        ,m_nDefaultChecked( STATE_NOCHECK )
+        ,m_bSupportSecondRefValue( _bSupportNoCheckRefValue )
+    {
+    }
+
+    //--------------------------------------------------------------------
+    OReferenceValueComponent::OReferenceValueComponent( const OReferenceValueComponent* _pOriginal, const   Reference< XMultiServiceFactory>& _rxFactory )
+        :OBoundControlModel( _pOriginal, _rxFactory )
+    {
+        m_sReferenceValue           = _pOriginal->m_sReferenceValue;
+        m_sNoCheckReferenceValue    = _pOriginal->m_sNoCheckReferenceValue;
+        m_nDefaultChecked           = _pOriginal->m_nDefaultChecked;
+        m_bSupportSecondRefValue    = _pOriginal->m_bSupportSecondRefValue;
+
+        calcValueExchangeType();
+    }
+
+    //--------------------------------------------------------------------
+    OReferenceValueComponent::~OReferenceValueComponent()
+    {
+    }
+
+    //--------------------------------------------------------------------
+    void OReferenceValueComponent::setReferenceValue( const ::rtl::OUString& _rRefValue )
+    {
+        m_sReferenceValue = _rRefValue;
+        calcValueExchangeType();
+    }
+
+    //--------------------------------------------------------------------
+    void OReferenceValueComponent::setNoCheckReferenceValue( const ::rtl::OUString& _rNoCheckRefValue )
+    {
+        OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::setNoCheckReferenceValue: no support for a second reference value!" );
+        if ( m_bSupportSecondRefValue )
+            m_sNoCheckReferenceValue = _rNoCheckRefValue;
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL OReferenceValueComponent::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
+    {
+        switch ( _nHandle )
+        {
+        case PROPERTY_ID_REFVALUE:          _rValue <<= m_sReferenceValue; break;
+        case PROPERTY_ID_DEFAULTCHECKED:    _rValue <<= m_nDefaultChecked; break;
+
+        case PROPERTY_ID_UNCHECKED_REFVALUE:
+            OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::getFastPropertyValue: not supported!" );
+            _rValue <<= m_sNoCheckReferenceValue;
+            break;
+
+        default:
+            OBoundControlModel::getFastPropertyValue( _rValue, _nHandle );
+        }
+    }
+
+    //--------------------------------------------------------------------
+    void SAL_CALL OReferenceValueComponent::setFastPropertyValue_NoBroadcast( sal_Int32 _nHandle, const Any& _rValue ) throw (Exception)
+    {
+        switch ( _nHandle )
+        {
+        case PROPERTY_ID_REFVALUE :
+            OSL_VERIFY( _rValue >>= m_sReferenceValue );
+            calcValueExchangeType();
+            break;
+
+        case PROPERTY_ID_UNCHECKED_REFVALUE:
+            OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::setFastPropertyValue_NoBroadcast: not supported!" );
+            OSL_VERIFY( _rValue >>= m_sNoCheckReferenceValue );
+            break;
+
+        case PROPERTY_ID_DEFAULTCHECKED :
+            OSL_VERIFY( _rValue >>= m_nDefaultChecked );
+            resetNoBroadcast();
+            break;
+
+        default:
+            OBoundControlModel::setFastPropertyValue_NoBroadcast( _nHandle, _rValue );
+        }
+    }
+
+    //--------------------------------------------------------------------
+    sal_Bool SAL_CALL OReferenceValueComponent::convertFastPropertyValue( Any& _rConvertedValue, Any& _rOldValue, sal_Int32 _nHandle, const Any& _rValue ) throw (IllegalArgumentException)
+    {
+        sal_Bool bModified = sal_False;
+        switch ( _nHandle )
+        {
+        case PROPERTY_ID_REFVALUE:
+            bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sReferenceValue );
+            break;
+
+        case PROPERTY_ID_UNCHECKED_REFVALUE:
+            OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::convertFastPropertyValue: not supported!" );
+            bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sNoCheckReferenceValue );
+            break;
+
+        case PROPERTY_ID_DEFAULTCHECKED:
+            bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_nDefaultChecked );
+            break;
+
+        default:
+            bModified = OBoundControlModel::convertFastPropertyValue( _rConvertedValue, _rOldValue, _nHandle, _rValue );
+            break;
+        }
+        return bModified;
+    }
+
+    //------------------------------------------------------------------------------
+    Any OReferenceValueComponent::getDefaultForReset() const
+    {
+        return makeAny( (sal_Int16)m_nDefaultChecked );
+    }
+
+    //--------------------------------------------------------------------
+    void OReferenceValueComponent::fillProperties( Sequence< Property >& /* [out] */ _rProps, Sequence< Property >& /* [out] */ _rAggregateProps ) const
+    {
+        BEGIN_DESCRIBE_PROPERTIES( m_bSupportSecondRefValue ? 3 : 2, OBoundControlModel )
+            DECL_PROP1( REFVALUE,       ::rtl::OUString,    BOUND );
+            DECL_PROP1( DEFAULTCHECKED, sal_Int16,          BOUND );
+            if ( m_bSupportSecondRefValue )
+            {
+                DECL_PROP1( UNCHECKED_REFVALUE, ::rtl::OUString,    BOUND );
+            }
+        END_DESCRIBE_PROPERTIES();
+    }
+
+    //-----------------------------------------------------------------------------
+    void OReferenceValueComponent::calcValueExchangeType()
+    {
+        m_eValueExchangeType = eBoolean;
+        if  (  m_sReferenceValue.getLength()
+            && hasExternalValueBinding()
+            && getExternalValueBinding()->supportsType( ::getCppuType( static_cast< ::rtl::OUString* >( NULL ) ) )
+            )
+            m_eValueExchangeType = eString;
+    }
+
+    //-----------------------------------------------------------------------------
+    sal_Bool OReferenceValueComponent::approveValueBinding( const Reference< XValueBinding >& _rxBinding )
+    {
+        OSL_PRECOND( _rxBinding.is(), "OReferenceValueComponent::approveValueBinding: invalid binding!" );
+
+        // only strings are accepted for simplicity
+        return  _rxBinding.is()
+            &&  (   _rxBinding->supportsType( ::getCppuType( static_cast< ::rtl::OUString* >( NULL ) ) )
+                ||  _rxBinding->supportsType( ::getCppuType( static_cast< sal_Bool* >( NULL ) ) )
+                );
+    }
+
+    //-----------------------------------------------------------------------------
+    void OReferenceValueComponent::onConnectedExternalValue( )
+    {
+        calcValueExchangeType();
+        OBoundControlModel::onConnectedExternalValue( );
+    }
+
+    //-----------------------------------------------------------------------------
+    Any OReferenceValueComponent::translateExternalValueToControlValue( )
+    {
+        OSL_PRECOND( getExternalValueBinding().is(), "OReferenceValueComponent::commitControlValueToExternalBinding: no active binding!" );
+
+        sal_Int16 nState = STATE_DONTKNOW;
+        if ( getExternalValueBinding().is() )
+        {
+            try
+            {
+                switch ( m_eValueExchangeType )
+                {
+                case eBoolean:
+                {
+                    Any aExternalValue = getExternalValueBinding()->getValue( ::getCppuType( static_cast< sal_Bool* >( NULL ) ) );
+                    sal_Bool bState = sal_False;
+                    if ( aExternalValue >>= bState )
+                        nState = bState ? STATE_CHECK : STATE_NOCHECK;
+                }
+                break;
+
+                case eString:
+                {
+                    Any aExternalValue = getExternalValueBinding()->getValue( ::getCppuType( static_cast< ::rtl::OUString* >( NULL ) ) );
+                    ::rtl::OUString sExternalValue;
+                    if ( aExternalValue >>= sExternalValue )
+                    {
+                        if ( sExternalValue == m_sReferenceValue )
+                            nState = STATE_CHECK;
+                        else
+                        {
+                            if ( !m_bSupportSecondRefValue || ( sExternalValue == m_sNoCheckReferenceValue ) )
+                                nState = STATE_NOCHECK;
+                            else
+                                nState = STATE_DONTKNOW;
+                        }
+                    }
+                }
+                break;
+                }
+            }
+            catch( const Exception& )
+            {
+                OSL_ENSURE( sal_False, "OReferenceValueComponent::translateExternalValueToControlValue: caught an exception!" );
+            }
+        }
+
+        return makeAny( nState );
+    }
+
+    //-----------------------------------------------------------------------------
+    Any OReferenceValueComponent::translateControlValueToExternalValue( )
+    {
+        Any aExternalValue;
+
+        try
+        {
+            Any aControlValue( m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) );
+            sal_Int16 nControlValue = STATE_DONTKNOW;
+            aControlValue >>= nControlValue;
+
+            switch( nControlValue )
+            {
+            case STATE_CHECK:
+                if ( m_eValueExchangeType == eBoolean )
+                {
+                    aExternalValue <<= (sal_Bool)sal_True;
+                }
+                else if ( m_eValueExchangeType == eString )
+                {
+                    aExternalValue <<= m_sReferenceValue;
+                }
+                break;
+
+            case STATE_NOCHECK:
+                if ( m_eValueExchangeType == eBoolean )
+                {
+                    aExternalValue <<= (sal_Bool)sal_False;
+                }
+                else if ( m_eValueExchangeType == eString )
+                {
+                    aExternalValue <<= m_bSupportSecondRefValue ? m_sNoCheckReferenceValue : ::rtl::OUString();
+                }
+                break;
+            }
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "OReferenceValueComponent::translateControlValueToExternalValue: caught an exception!" );
+        }
+
+        return aExternalValue;
+    }
+
+//........................................................................
+} // namespace frm
+//........................................................................
+