forms/source/component/RadioButton.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "RadioButton.hxx"
  21 #include "GroupManager.hxx"
  22 #include <property.hxx>
  23 #include <services.hxx>
  24 #include <comphelper/basicio.hxx>
  25 #include <comphelper/property.hxx>
  26 #include <tools/debug.hxx>
  27 #include <com/sun/star/beans/PropertyAttribute.hpp>
  28 #include <com/sun/star/container/XIndexAccess.hpp>
  29 #include <com/sun/star/form/FormComponentType.hpp>
  30
  31 namespace frm
  32 {
  33 using namespace ::com::sun::star::uno;
  34 using namespace ::com::sun::star::sdb;
  35 using namespace ::com::sun::star::sdbc;
  36 using namespace ::com::sun::star::beans;
  37 using namespace ::com::sun::star::container;
  38 using namespace ::com::sun::star::form;
  39 using namespace ::com::sun::star::io;
  40 using namespace ::com::sun::star::util;
  41
  42
  43 css::uno::Sequence<OUString> SAL_CALL ORadioButtonControl::getSupportedServiceNames()
  44 {
  45     css::uno::Sequence<OUString> aSupported = OBoundControl::getSupportedServiceNames();
  46     aSupported.realloc(aSupported.getLength() + 2);
  47
  48     OUString* pArray = aSupported.getArray();
  49     pArray[aSupported.getLength()-2] = FRM_SUN_CONTROL_RADIOBUTTON;
  50     pArray[aSupported.getLength()-1] = STARDIV_ONE_FORM_CONTROL_RADIOBUTTON;
  51     return aSupported;
  52 }
  53
  54
  55 ORadioButtonControl::ORadioButtonControl(const Reference<XComponentContext>& _rxFactory)
  56                       :OBoundControl(_rxFactory, VCL_CONTROL_RADIOBUTTON)
  57 {
  58 }
  59
  60
  61 ORadioButtonModel::ORadioButtonModel(const Reference<XComponentContext>& _rxFactory)
  62     :OReferenceValueComponent( _rxFactory, VCL_CONTROLMODEL_RADIOBUTTON, FRM_SUN_CONTROL_RADIOBUTTON )
  63                     // use the old control name for compatibility reasons
  64 {
  65
  66     m_nClassId = FormComponentType::RADIOBUTTON;
  67     m_aLabelServiceName = FRM_SUN_COMPONENT_GROUPBOX;
  68     initValueProperty( PROPERTY_STATE, PROPERTY_ID_STATE );
  69     startAggregatePropertyListening( PROPERTY_GROUP_NAME );
  70 }
  71
  72
  73 ORadioButtonModel::ORadioButtonModel( const ORadioButtonModel* _pOriginal, const Reference<XComponentContext>& _rxFactory )
  74     :OReferenceValueComponent( _pOriginal, _rxFactory )
  75 {
  76 }
  77
  78
  79 ORadioButtonModel::~ORadioButtonModel()
  80 {
  81 }
  82
  83 // XCloneable
  84
  85 css::uno::Reference< css::util::XCloneable > SAL_CALL ORadioButtonModel::createClone()
  86 {
  87     rtl::Reference<ORadioButtonModel> pClone = new ORadioButtonModel(this, getContext());
  88     pClone->clonedFrom(this);
  89     return pClone;
  90 }
  91
  92 // XServiceInfo
  93
  94 css::uno::Sequence<OUString> SAL_CALL ORadioButtonModel::getSupportedServiceNames()
  95 {
  96     css::uno::Sequence<OUString> aSupported = OReferenceValueComponent::getSupportedServiceNames();
  97
  98     sal_Int32 nOldLen = aSupported.getLength();
  99     aSupported.realloc( nOldLen + 9 );
 100     OUString* pStoreTo = aSupported.getArray() + nOldLen;
 101
 102     *pStoreTo++ = BINDABLE_CONTROL_MODEL;
 103     *pStoreTo++ = DATA_AWARE_CONTROL_MODEL;
 104     *pStoreTo++ = VALIDATABLE_CONTROL_MODEL;
 105
 106     *pStoreTo++ = BINDABLE_DATA_AWARE_CONTROL_MODEL;
 107     *pStoreTo++ = VALIDATABLE_BINDABLE_CONTROL_MODEL;
 108
 109     *pStoreTo++ = FRM_SUN_COMPONENT_RADIOBUTTON;
 110     *pStoreTo++ = FRM_SUN_COMPONENT_DATABASE_RADIOBUTTON;
 111     *pStoreTo++ = BINDABLE_DATABASE_RADIO_BUTTON;
 112
 113     *pStoreTo++ = FRM_COMPONENT_RADIOBUTTON;
 114
 115     return aSupported;
 116 }
 117
 118
 119 void ORadioButtonModel::SetSiblingPropsTo(const OUString& rPropName, const Any& rValue)
 120 {
 121     // my name
 122     OUString sMyGroup;
 123     if (hasProperty(PROPERTY_GROUP_NAME, this))
 124         getPropertyValue(PROPERTY_GROUP_NAME) >>= sMyGroup;
 125     if (sMyGroup.isEmpty())
 126         sMyGroup = m_aName;
 127
 128     // Iterate over my siblings
 129     Reference<XIndexAccess> xIndexAccess(getParent(), UNO_QUERY);
 130     if (!xIndexAccess.is())
 131         return;
 132
 133     Reference<XPropertySet> xMyProps = this;
 134     OUString sCurrentGroup;
 135     sal_Int32 nNumSiblings = xIndexAccess->getCount();
 136     for (sal_Int32 i=0; i<nNumSiblings; ++i)
 137     {
 138         Reference<XPropertySet> xSiblingProperties(xIndexAccess->getByIndex(i), UNO_QUERY);
 139         if (!xSiblingProperties.is())
 140             continue;
 141         if (xMyProps == xSiblingProperties)
 142             continue;   // do not set myself
 143
 144         // Only if it's a RadioButton
 145         if (!hasProperty(PROPERTY_CLASSID, xSiblingProperties))
 146             continue;
 147         sal_Int16 nType = 0;
 148         xSiblingProperties->getPropertyValue(PROPERTY_CLASSID) >>= nType;
 149         if (nType != FormComponentType::RADIOBUTTON)
 150             continue;
 151
 152         // The group association is attached to the name
 153         sCurrentGroup = OGroupManager::GetGroupName( xSiblingProperties );
 154         if (sCurrentGroup == sMyGroup)
 155             xSiblingProperties->setPropertyValue(rPropName, rValue);
 156     }
 157 }
 158
 159
 160 void ORadioButtonModel::setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const Any& rValue)
 161 {
 162     OReferenceValueComponent::setFastPropertyValue_NoBroadcast( nHandle, rValue );
 163
 164     // if the label control changed ...
 165     if (nHandle == PROPERTY_ID_CONTROLLABEL)
 166     {   // ... forward this to our siblings
 167         SetSiblingPropsTo(PROPERTY_CONTROLLABEL, rValue);
 168     }
 169
 170     // If the ControlSource property has changed ...
 171     if (nHandle == PROPERTY_ID_CONTROLSOURCE)
 172     {   // ... I have to pass the new ControlSource to my siblings, which are in the same RadioButton group as I am
 173         SetSiblingPropsTo(PROPERTY_CONTROLSOURCE, rValue);
 174     }
 175
 176     // The other way: if my name changes ...
 177     if (nHandle == PROPERTY_ID_NAME)
 178     {
 179         setControlSource();
 180     }
 181
 182     if (nHandle != PROPERTY_ID_DEFAULT_STATE)
 183         return;
 184
 185     sal_Int16 nValue;
 186     rValue >>= nValue;
 187     if (1 == nValue)
 188     {   // Reset the 'default checked' for all Radios of the same group.
 189         // Because (as the Highlander already knew): "There can be only one"
 190         Any aZero;
 191         nValue = 0;
 192         aZero <<= nValue;
 193         SetSiblingPropsTo(PROPERTY_DEFAULT_STATE, aZero);
 194     }
 195 }
 196
 197 void ORadioButtonModel::setControlSource()
 198 {
 199     Reference<XIndexAccess> xIndexAccess(getParent(), UNO_QUERY);
 200     if (!xIndexAccess.is())
 201         return;
 202
 203     OUString sName, sGroupName;
 204
 205     if (hasProperty(PROPERTY_GROUP_NAME, this))
 206         getPropertyValue(PROPERTY_GROUP_NAME) >>= sGroupName;
 207     getPropertyValue(PROPERTY_NAME) >>= sName;
 208
 209     Reference<XPropertySet> xMyProps = this;
 210     for (sal_Int32 i=0; i<xIndexAccess->getCount(); ++i)
 211     {
 212         Reference<XPropertySet> xSiblingProperties(xIndexAccess->getByIndex(i), UNO_QUERY);
 213         if (!xSiblingProperties.is())
 214             continue;
 215
 216         if (xMyProps == xSiblingProperties)
 217             // Only if I didn't find myself
 218             continue;
 219
 220         sal_Int16 nType = 0;
 221         xSiblingProperties->getPropertyValue(PROPERTY_CLASSID) >>= nType;
 222         if (nType != FormComponentType::RADIOBUTTON)
 223             // Only RadioButtons
 224             continue;
 225
 226         OUString sSiblingName, sSiblingGroupName;
 227         if (hasProperty(PROPERTY_GROUP_NAME, xSiblingProperties))
 228             xSiblingProperties->getPropertyValue(PROPERTY_GROUP_NAME) >>= sSiblingGroupName;
 229         xSiblingProperties->getPropertyValue(PROPERTY_NAME) >>= sSiblingName;
 230
 231         if ((sGroupName.isEmpty() && sSiblingGroupName.isEmpty() &&                 // (no group name
 232              sName == sSiblingName) ||                                              //  names match) or
 233             (!sGroupName.isEmpty() && !sSiblingGroupName.isEmpty() &&               // (have group name
 234              sGroupName == sSiblingGroupName))                                      //  they match)
 235         {
 236             setPropertyValue(PROPERTY_CONTROLSOURCE, xSiblingProperties->getPropertyValue(PROPERTY_CONTROLSOURCE));
 237             break;
 238         }
 239     }
 240 }
 241
 242
 243 void ORadioButtonModel::describeFixedProperties( Sequence< Property >& _rProps ) const
 244 {
 245     OReferenceValueComponent::describeFixedProperties( _rProps );
 246     sal_Int32 nOldCount = _rProps.getLength();
 247     _rProps.realloc( nOldCount + 1);
 248     css::beans::Property* pProperties = _rProps.getArray() + nOldCount;
 249     *pProperties++ = css::beans::Property(PROPERTY_TABINDEX, PROPERTY_ID_TABINDEX, cppu::UnoType<sal_Int16>::get(), css::beans::PropertyAttribute::BOUND);
 250     DBG_ASSERT( pProperties == _rProps.getArray() + _rProps.getLength(), "<...>::describeFixedProperties/getInfoHelper: forgot to adjust the count ?");
 251 }
 252
 253
 254 OUString SAL_CALL ORadioButtonModel::getServiceName()
 255 {
 256     return FRM_COMPONENT_RADIOBUTTON;   // old (non-sun) name for compatibility !
 257 }
 258
 259
 260 void SAL_CALL ORadioButtonModel::write(const Reference<XObjectOutputStream>& _rxOutStream)
 261 {
 262     OReferenceValueComponent::write(_rxOutStream);
 263
 264     // Version
 265     _rxOutStream->writeShort(0x0003);
 266
 267     // Properties
 268     _rxOutStream << getReferenceValue();
 269     _rxOutStream << static_cast<sal_Int16>(getDefaultChecked());
 270     writeHelpTextCompatibly(_rxOutStream);
 271
 272     // from version 0x0003 : common properties
 273     writeCommonProperties(_rxOutStream);
 274 }
 275
 276
 277 void SAL_CALL ORadioButtonModel::read(const Reference<XObjectInputStream>& _rxInStream)
 278 {
 279     OReferenceValueComponent::read(_rxInStream);
 280     ::osl::MutexGuard aGuard(m_aMutex);
 281
 282     // Version
 283     sal_uInt16 nVersion = _rxInStream->readShort();
 284
 285     OUString sReferenceValue;
 286     sal_Int16 nDefaultChecked( 0 );
 287     switch (nVersion)
 288     {
 289         case 0x0001 :
 290             _rxInStream >> sReferenceValue;
 291             _rxInStream >> nDefaultChecked;
 292             break;
 293         case 0x0002 :
 294             _rxInStream >> sReferenceValue;
 295             _rxInStream >> nDefaultChecked;
 296             readHelpTextCompatibly(_rxInStream);
 297             break;
 298         case 0x0003 :
 299             _rxInStream >> sReferenceValue;
 300             _rxInStream >> nDefaultChecked;
 301             readHelpTextCompatibly(_rxInStream);
 302             readCommonProperties(_rxInStream);
 303             break;
 304         default :
 305             OSL_FAIL("ORadioButtonModel::read : unknown version !");
 306             defaultCommonProperties();
 307             break;
 308     }
 309
 310     setReferenceValue( sReferenceValue );
 311     setDefaultChecked( static_cast<ToggleState>(nDefaultChecked) );
 312
 313     // Display default values after read
 314     if ( !getControlSource().isEmpty() )
 315         // (not if we don't have a control source - the "State" property acts like it is persistent, then
 316         resetNoBroadcast();
 317 }
 318
 319
 320 void ORadioButtonModel::_propertyChanged(const PropertyChangeEvent& _rEvent)
 321 {
 322     if ( _rEvent.PropertyName == PROPERTY_STATE )
 323     {
 324         if ( _rEvent.NewValue == sal_Int16(1) )
 325         {
 326             // If my status has changed to 'checked', I have to reset all my siblings, which are in the same group as I am
 327             Any aZero;
 328             aZero <<= sal_Int16(0);
 329             SetSiblingPropsTo( PROPERTY_STATE, aZero );
 330         }
 331     }
 332     else if ( _rEvent.PropertyName == PROPERTY_GROUP_NAME )
 333     {
 334         setControlSource();
 335         // Can't call OReferenceValueComponent::_propertyChanged(), as it
 336         // doesn't know what to do with the GroupName property.
 337         return;
 338     }
 339
 340     OReferenceValueComponent::_propertyChanged( _rEvent );
 341 }
 342
 343
 344 Any ORadioButtonModel::translateDbColumnToControlValue()
 345 {
 346     return Any( static_cast<sal_Int16>( ( m_xColumn->getString() == getReferenceValue() ) ? TRISTATE_TRUE : TRISTATE_FALSE )
 347     );
 348 }
 349
 350
 351 Any ORadioButtonModel::translateExternalValueToControlValue( const Any& _rExternalValue ) const
 352 {
 353     Any aControlValue = OReferenceValueComponent::translateExternalValueToControlValue( _rExternalValue );
 354     sal_Int16 nState = TRISTATE_FALSE;
 355     if ( ( aControlValue >>= nState ) && ( nState == TRISTATE_INDET ) )
 356         // radio buttons do not have the DONTKNOW state
 357         aControlValue <<= sal_Int16(TRISTATE_FALSE);
 358     return aControlValue;
 359 }
 360
 361
 362 bool ORadioButtonModel::commitControlValueToDbColumn( bool /*_bPostReset*/ )
 363 {
 364     Reference< XPropertySet > xField( getField() );
 365     OSL_PRECOND( xField.is(), "ORadioButtonModel::commitControlValueToDbColumn: not bound!" );
 366     if ( xField.is() )
 367     {
 368         try
 369         {
 370             sal_Int16 nValue = 0;
 371             m_xAggregateSet->getPropertyValue( PROPERTY_STATE ) >>= nValue;
 372             if ( nValue == 1 )
 373                 xField->setPropertyValue( PROPERTY_VALUE, Any( getReferenceValue() ) );
 374         }
 375         catch(const Exception&)
 376         {
 377             OSL_FAIL("ORadioButtonModel::commitControlValueToDbColumn: could not commit !");
 378         }
 379     }
 380     return true;
 381 }
 382
 383 }
 384
 385 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 386 com_sun_star_form_ORadioButtonModel_get_implementation(css::uno::XComponentContext* component,
 387         css::uno::Sequence<css::uno::Any> const &)
 388 {
 389     return cppu::acquire(new frm::ORadioButtonModel(component));
 390 }
 391
 392 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
 393 com_sun_star_form_ORadioButtonControl_get_implementation(css::uno::XComponentContext* component,
 394         css::uno::Sequence<css::uno::Any> const &)
 395 {
 396     return cppu::acquire(new frm::ORadioButtonControl(component));
 397 }
 398
 399 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */