forms/source/component/refvaluecomponent.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: refvaluecomponent.cxx,v $
  10  * $Revision: 1.12 $
  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 "refvaluecomponent.hxx"
  34
  35 /** === begin UNO includes === **/
  36 /** === end UNO includes === **/
  37
  38 #include <tools/diagnose_ex.h>
  39
  40 #include <list>
  41
  42 //........................................................................
  43 namespace frm
  44 {
  45 //........................................................................
  46
  47     using namespace ::com::sun::star::uno;
  48     using namespace ::com::sun::star::lang;
  49     using namespace ::com::sun::star::beans;
  50     using namespace ::com::sun::star::form::binding;
  51
  52     //====================================================================
  53     //=
  54     //====================================================================
  55     //--------------------------------------------------------------------
  56     OReferenceValueComponent::OReferenceValueComponent( const Reference< XMultiServiceFactory>& _rxFactory, const ::rtl::OUString& _rUnoControlModelTypeName, const ::rtl::OUString& _rDefault, sal_Bool _bSupportNoCheckRefValue )
  57         :OBoundControlModel( _rxFactory, _rUnoControlModelTypeName, _rDefault, sal_False, sal_True, sal_True )
  58         ,m_eDefaultChecked( STATE_NOCHECK )
  59         ,m_bSupportSecondRefValue( _bSupportNoCheckRefValue )
  60     {
  61     }
  62
  63     //--------------------------------------------------------------------
  64     OReferenceValueComponent::OReferenceValueComponent( const OReferenceValueComponent* _pOriginal, const       Reference< XMultiServiceFactory>& _rxFactory )
  65         :OBoundControlModel( _pOriginal, _rxFactory )
  66     {
  67         m_sReferenceValue           = _pOriginal->m_sReferenceValue;
  68         m_sNoCheckReferenceValue    = _pOriginal->m_sNoCheckReferenceValue;
  69         m_eDefaultChecked           = _pOriginal->m_eDefaultChecked;
  70         m_bSupportSecondRefValue    = _pOriginal->m_bSupportSecondRefValue;
  71
  72         calculateExternalValueType();
  73     }
  74
  75     //--------------------------------------------------------------------
  76     OReferenceValueComponent::~OReferenceValueComponent()
  77     {
  78     }
  79
  80     //--------------------------------------------------------------------
  81     void OReferenceValueComponent::setReferenceValue( const ::rtl::OUString& _rRefValue )
  82     {
  83         m_sReferenceValue = _rRefValue;
  84         calculateExternalValueType();
  85     }
  86
  87     //--------------------------------------------------------------------
  88     void SAL_CALL OReferenceValueComponent::getFastPropertyValue( Any& _rValue, sal_Int32 _nHandle ) const
  89     {
  90         switch ( _nHandle )
  91         {
  92         case PROPERTY_ID_REFVALUE:          _rValue <<= m_sReferenceValue; break;
  93         case PROPERTY_ID_DEFAULT_STATE:    _rValue <<= (sal_Int16)m_eDefaultChecked; break;
  94
  95         case PROPERTY_ID_UNCHECKED_REFVALUE:
  96             OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::getFastPropertyValue: not supported!" );
  97             _rValue <<= m_sNoCheckReferenceValue;
  98             break;
  99
 100         default:
 101             OBoundControlModel::getFastPropertyValue( _rValue, _nHandle );
 102         }
 103     }
 104
 105     //--------------------------------------------------------------------
 106     void SAL_CALL OReferenceValueComponent::setFastPropertyValue_NoBroadcast( sal_Int32 _nHandle, const Any& _rValue ) throw (Exception)
 107     {
 108         switch ( _nHandle )
 109         {
 110         case PROPERTY_ID_REFVALUE :
 111             OSL_VERIFY( _rValue >>= m_sReferenceValue );
 112             calculateExternalValueType();
 113             break;
 114
 115         case PROPERTY_ID_UNCHECKED_REFVALUE:
 116             OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::setFastPropertyValue_NoBroadcast: not supported!" );
 117             OSL_VERIFY( _rValue >>= m_sNoCheckReferenceValue );
 118             break;
 119
 120         case PROPERTY_ID_DEFAULT_STATE:
 121         {
 122             sal_Int16 nDefaultChecked( (sal_Int16)STATE_NOCHECK );
 123             OSL_VERIFY( _rValue >>= nDefaultChecked );
 124             m_eDefaultChecked = (ToggleState)nDefaultChecked;
 125             resetNoBroadcast();
 126         }
 127         break;
 128
 129         default:
 130             OBoundControlModel::setFastPropertyValue_NoBroadcast( _nHandle, _rValue );
 131         }
 132     }
 133
 134     //--------------------------------------------------------------------
 135     sal_Bool SAL_CALL OReferenceValueComponent::convertFastPropertyValue( Any& _rConvertedValue, Any& _rOldValue, sal_Int32 _nHandle, const Any& _rValue ) throw (IllegalArgumentException)
 136     {
 137         sal_Bool bModified = sal_False;
 138         switch ( _nHandle )
 139         {
 140         case PROPERTY_ID_REFVALUE:
 141             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sReferenceValue );
 142             break;
 143
 144         case PROPERTY_ID_UNCHECKED_REFVALUE:
 145             OSL_ENSURE( m_bSupportSecondRefValue, "OReferenceValueComponent::convertFastPropertyValue: not supported!" );
 146             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, m_sNoCheckReferenceValue );
 147             break;
 148
 149         case PROPERTY_ID_DEFAULT_STATE:
 150             bModified = tryPropertyValue( _rConvertedValue, _rOldValue, _rValue, (sal_Int16)m_eDefaultChecked );
 151             break;
 152
 153         default:
 154             bModified = OBoundControlModel::convertFastPropertyValue( _rConvertedValue, _rOldValue, _nHandle, _rValue );
 155             break;
 156         }
 157         return bModified;
 158     }
 159
 160     //------------------------------------------------------------------------------
 161     Any OReferenceValueComponent::getDefaultForReset() const
 162     {
 163         return makeAny( (sal_Int16)m_eDefaultChecked );
 164     }
 165
 166     //--------------------------------------------------------------------
 167     void OReferenceValueComponent::describeFixedProperties( Sequence< Property >& _rProps ) const
 168     {
 169         BEGIN_DESCRIBE_PROPERTIES( m_bSupportSecondRefValue ? 3 : 2, OBoundControlModel )
 170             DECL_PROP1( REFVALUE,       ::rtl::OUString,    BOUND );
 171             DECL_PROP1( DEFAULT_STATE, sal_Int16,          BOUND );
 172             if ( m_bSupportSecondRefValue )
 173             {
 174                 DECL_PROP1( UNCHECKED_REFVALUE, ::rtl::OUString,    BOUND );
 175             }
 176         END_DESCRIBE_PROPERTIES();
 177     }
 178
 179     //-----------------------------------------------------------------------------
 180     Sequence< Type > OReferenceValueComponent::getSupportedBindingTypes()
 181     {
 182         ::std::list< Type > aTypes;
 183         aTypes.push_back( ::getCppuType( static_cast< sal_Bool* >( NULL ) ) );
 184
 185         if ( m_sReferenceValue.getLength() )
 186             aTypes.push_front( ::getCppuType( static_cast< ::rtl::OUString* >( NULL ) ) );
 187             // push_front, because this is the preferred type
 188
 189         Sequence< Type > aTypesRet( aTypes.size() );
 190         ::std::copy( aTypes.begin(), aTypes.end(), aTypesRet.getArray() );
 191         return aTypesRet;
 192     }
 193
 194     //-----------------------------------------------------------------------------
 195     Any OReferenceValueComponent::translateExternalValueToControlValue( const Any& _rExternalValue ) const
 196     {
 197         sal_Int16 nState = STATE_DONTKNOW;
 198
 199         sal_Bool bExternalState = sal_False;
 200         ::rtl::OUString sExternalValue;
 201         if ( _rExternalValue >>= bExternalState )
 202         {
 203             nState = ::sal::static_int_cast< sal_Int16 >( bExternalState ? STATE_CHECK : STATE_NOCHECK );
 204         }
 205         else if ( _rExternalValue >>= sExternalValue )
 206         {
 207             if ( sExternalValue == m_sReferenceValue )
 208                 nState = STATE_CHECK;
 209             else
 210             {
 211                 if ( !m_bSupportSecondRefValue || ( sExternalValue == m_sNoCheckReferenceValue ) )
 212                     nState = STATE_NOCHECK;
 213                 else
 214                     nState = STATE_DONTKNOW;
 215             }
 216         }
 217         else if ( !_rExternalValue.hasValue() )
 218         {
 219             nState = STATE_DONTKNOW;
 220         }
 221         else
 222         {
 223             OSL_ENSURE( false, "OReferenceValueComponent::translateExternalValueToControlValue: unexpected value type!" );
 224         }
 225
 226         return makeAny( nState );
 227     }
 228
 229     //-----------------------------------------------------------------------------
 230     Any OReferenceValueComponent::translateControlValueToExternalValue( ) const
 231     {
 232         Any aExternalValue;
 233
 234         try
 235         {
 236             Any aControlValue( m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) );
 237             sal_Int16 nControlValue = STATE_DONTKNOW;
 238             aControlValue >>= nControlValue;
 239
 240             bool bBooleanExchange = getExternalValueType().getTypeClass() == TypeClass_BOOLEAN;
 241             bool bStringExchange = getExternalValueType().getTypeClass() == TypeClass_STRING;
 242             OSL_ENSURE( bBooleanExchange || bStringExchange,
 243                 "OReferenceValueComponent::translateControlValueToExternalValue: unexpected value exchange type!" );
 244
 245             switch( nControlValue )
 246             {
 247             case STATE_CHECK:
 248                 if ( bBooleanExchange )
 249                 {
 250                     aExternalValue <<= (sal_Bool)sal_True;
 251                 }
 252                 else if ( bStringExchange )
 253                 {
 254                     aExternalValue <<= m_sReferenceValue;
 255                 }
 256                 break;
 257
 258             case STATE_NOCHECK:
 259                 if ( bBooleanExchange )
 260                 {
 261                     aExternalValue <<= (sal_Bool)sal_False;
 262                 }
 263                 else if ( bStringExchange )
 264                 {
 265                     aExternalValue <<= m_bSupportSecondRefValue ? m_sNoCheckReferenceValue : ::rtl::OUString();
 266                 }
 267                 break;
 268             }
 269         }
 270         catch( const Exception& )
 271         {
 272             OSL_ENSURE( sal_False, "OReferenceValueComponent::translateControlValueToExternalValue: caught an exception!" );
 273         }
 274
 275         return aExternalValue;
 276     }
 277
 278     //-----------------------------------------------------------------------------
 279     Any OReferenceValueComponent::translateControlValueToValidatableValue( ) const
 280     {
 281         if ( !m_xAggregateSet.is() )
 282             return Any();
 283
 284         Any aControlValue( m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) );
 285         sal_Int16 nControlValue = STATE_DONTKNOW;
 286         aControlValue >>= nControlValue;
 287
 288         Any aValidatableValue;
 289         switch ( nControlValue )
 290         {
 291         case STATE_CHECK:
 292             aValidatableValue <<= (sal_Bool)sal_True;
 293             break;
 294         case STATE_NOCHECK:
 295             aValidatableValue <<= (sal_Bool)sal_False;
 296             break;
 297         }
 298         return aValidatableValue;
 299     }
 300
 301 //........................................................................
 302 } // namespace frm
 303 //........................................................................
 304