chart2/source/controller/chartapiwrapper/LegendWrapper.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: LegendWrapper.cxx,v $
  10  * $Revision: 1.9.16.4 $
  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_chart2.hxx"
  33 #include "LegendWrapper.hxx"
  34 #include "macros.hxx"
  35 #include "Chart2ModelContact.hxx"
  36 #include "LegendHelper.hxx"
  37 #include "ContainerHelper.hxx"
  38 #include <comphelper/InlineContainer.hxx>
  39 #include <com/sun/star/beans/PropertyAttribute.hpp>
  40 #include <com/sun/star/chart2/XTitled.hpp>
  41 #include <com/sun/star/chart/ChartLegendPosition.hpp>
  42 #include <com/sun/star/chart2/LegendPosition.hpp>
  43 #include <com/sun/star/chart2/LegendExpansion.hpp>
  44 #include <com/sun/star/chart2/RelativePosition.hpp>
  45 #include <com/sun/star/drawing/FillStyle.hpp>
  46
  47 #include "CharacterProperties.hxx"
  48 #include "LineProperties.hxx"
  49 #include "FillProperties.hxx"
  50 #include "UserDefinedProperties.hxx"
  51 #include "WrappedCharacterHeightProperty.hxx"
  52 #include "PositionAndSizeHelper.hxx"
  53 #include "WrappedDirectStateProperty.hxx"
  54 #include "WrappedAutomaticPositionProperties.hxx"
  55 #include "WrappedScaleTextProperties.hxx"
  56
  57 #include <algorithm>
  58 #include <rtl/ustrbuf.hxx>
  59
  60 using namespace ::com::sun::star;
  61 using ::com::sun::star::beans::Property;
  62 using ::osl::MutexGuard;
  63 using ::com::sun::star::uno::Any;
  64 using ::com::sun::star::uno::Reference;
  65 using ::com::sun::star::uno::Sequence;
  66
  67 //-----------------------------------------------------------------------------
  68 //-----------------------------------------------------------------------------
  69
  70 namespace chart
  71 {
  72 class WrappedLegendAlignmentProperty : public WrappedProperty
  73 {
  74 public:
  75     WrappedLegendAlignmentProperty();
  76     virtual ~WrappedLegendAlignmentProperty();
  77
  78     virtual void setPropertyValue( const Any& rOuterValue, const Reference< beans::XPropertySet >& xInnerPropertySet ) const
  79                                     throw (beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException, lang::WrappedTargetException, uno::RuntimeException);
  80     virtual Any getPropertyValue( const Reference< beans::XPropertySet >& xInnerPropertySet ) const
  81                                     throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException);
  82
  83 protected:
  84     virtual Any convertInnerToOuterValue( const Any& rInnerValue ) const;
  85     virtual Any convertOuterToInnerValue( const Any& rOuterValue ) const;
  86 };
  87
  88 WrappedLegendAlignmentProperty::WrappedLegendAlignmentProperty()
  89     : ::chart::WrappedProperty( C2U( "Alignment" ), C2U( "AnchorPosition" ) )
  90 {
  91 }
  92 WrappedLegendAlignmentProperty::~WrappedLegendAlignmentProperty()
  93 {
  94 }
  95
  96 Any WrappedLegendAlignmentProperty::getPropertyValue( const Reference< beans::XPropertySet >& xInnerPropertySet ) const
  97                         throw (beans::UnknownPropertyException, lang::WrappedTargetException, uno::RuntimeException)
  98 {
  99     Any aRet;
 100     if( xInnerPropertySet.is() )
 101     {
 102         sal_Bool bShowLegend = sal_True;
 103         xInnerPropertySet->getPropertyValue( C2U( "Show" ) ) >>= bShowLegend;
 104         if(!bShowLegend)
 105         {
 106             aRet = uno::makeAny( ::com::sun::star::chart::ChartLegendPosition_NONE );
 107         }
 108         else
 109         {
 110             aRet = xInnerPropertySet->getPropertyValue( m_aInnerName );
 111             aRet = this->convertInnerToOuterValue( aRet );
 112         }
 113     }
 114     return aRet;
 115 }
 116
 117 void WrappedLegendAlignmentProperty::setPropertyValue( const Any& rOuterValue, const Reference< beans::XPropertySet >& xInnerPropertySet ) const
 118                 throw (beans::UnknownPropertyException, beans::PropertyVetoException, lang::IllegalArgumentException, lang::WrappedTargetException, uno::RuntimeException)
 119 {
 120     if(xInnerPropertySet.is())
 121     {
 122         sal_Bool bNewShowLegend = sal_True;
 123         sal_Bool bOldShowLegend = sal_True;
 124         {
 125             ::com::sun::star::chart::ChartLegendPosition eOuterPos(::com::sun::star::chart::ChartLegendPosition_NONE);
 126             if( (rOuterValue >>= eOuterPos)  && eOuterPos == ::com::sun::star::chart::ChartLegendPosition_NONE )
 127                 bNewShowLegend = sal_False;
 128             xInnerPropertySet->getPropertyValue( C2U( "Show" ) ) >>= bOldShowLegend;
 129         }
 130         if(bNewShowLegend!=bOldShowLegend)
 131         {
 132             xInnerPropertySet->setPropertyValue( C2U( "Show" ), uno::makeAny(bNewShowLegend) );
 133         }
 134         if(!bNewShowLegend)
 135             return;
 136
 137         //set corresponding LegendPosition
 138         Any aInnerValue = this->convertOuterToInnerValue( rOuterValue );
 139         xInnerPropertySet->setPropertyValue( m_aInnerName, aInnerValue );
 140
 141         //correct LegendExpansion
 142         chart2::LegendPosition eNewInnerPos(chart2::LegendPosition_LINE_END);
 143         if( aInnerValue >>= eNewInnerPos )
 144         {
 145             chart2::LegendExpansion eNewExpansion =
 146                 ( eNewInnerPos == chart2::LegendPosition_LINE_END ||
 147                   eNewInnerPos == chart2::LegendPosition_LINE_START )
 148                 ? chart2::LegendExpansion_HIGH
 149                 : chart2::LegendExpansion_WIDE;
 150
 151             chart2::LegendExpansion eOldExpansion( chart2::LegendExpansion_HIGH );
 152             bool bExpansionWasSet(
 153                 xInnerPropertySet->getPropertyValue( C2U( "Expansion" ) ) >>= eOldExpansion );
 154
 155             if( !bExpansionWasSet || (eOldExpansion != eNewExpansion))
 156                 xInnerPropertySet->setPropertyValue( C2U( "Expansion" ), uno::makeAny( eNewExpansion ));
 157         }
 158
 159         //correct RelativePosition
 160         Any aRelativePosition( xInnerPropertySet->getPropertyValue( C2U( "RelativePosition" ) ) );
 161         if(aRelativePosition.hasValue())
 162         {
 163             xInnerPropertySet->setPropertyValue( C2U( "RelativePosition" ), Any() );
 164         }
 165     }
 166 }
 167
 168 Any WrappedLegendAlignmentProperty::convertInnerToOuterValue( const Any& rInnerValue ) const
 169 {
 170     ::com::sun::star::chart::ChartLegendPosition ePos = ::com::sun::star::chart::ChartLegendPosition_NONE;
 171
 172     chart2::LegendPosition eNewPos;
 173     if( rInnerValue >>= eNewPos )
 174     {
 175         switch( eNewPos )
 176         {
 177             case chart2::LegendPosition_LINE_START:
 178                 ePos = ::com::sun::star::chart::ChartLegendPosition_LEFT;
 179                 break;
 180             case chart2::LegendPosition_LINE_END:
 181                 ePos = ::com::sun::star::chart::ChartLegendPosition_RIGHT;
 182                 break;
 183             case chart2::LegendPosition_PAGE_START:
 184                 ePos = ::com::sun::star::chart::ChartLegendPosition_TOP;
 185                 break;
 186             case chart2::LegendPosition_PAGE_END:
 187                 ePos = ::com::sun::star::chart::ChartLegendPosition_BOTTOM;
 188                 break;
 189
 190             default:
 191                 ePos = ::com::sun::star::chart::ChartLegendPosition_NONE;
 192                 break;
 193         }
 194     }
 195     return uno::makeAny( ePos );
 196 }
 197 Any WrappedLegendAlignmentProperty::convertOuterToInnerValue( const Any& rOuterValue ) const
 198 {
 199     chart2::LegendPosition eNewPos = chart2::LegendPosition_LINE_END;
 200
 201     ::com::sun::star::chart::ChartLegendPosition ePos;
 202     if( rOuterValue >>= ePos )
 203     {
 204         switch( ePos )
 205         {
 206             case ::com::sun::star::chart::ChartLegendPosition_LEFT:
 207                 eNewPos = chart2::LegendPosition_LINE_START;
 208                 break;
 209             case ::com::sun::star::chart::ChartLegendPosition_RIGHT:
 210                 eNewPos = chart2::LegendPosition_LINE_END;
 211                 break;
 212             case ::com::sun::star::chart::ChartLegendPosition_TOP:
 213                 eNewPos = chart2::LegendPosition_PAGE_START;
 214                 break;
 215             case ::com::sun::star::chart::ChartLegendPosition_BOTTOM:
 216                 eNewPos = chart2::LegendPosition_PAGE_END;
 217                 break;
 218             default: // NONE
 219                 break;
 220         }
 221     }
 222
 223     return uno::makeAny( eNewPos );
 224 }
 225 }
 226 //-----------------------------------------------------------------------------
 227 //-----------------------------------------------------------------------------
 228 //-----------------------------------------------------------------------------
 229 //-----------------------------------------------------------------------------
 230
 231 namespace
 232 {
 233 static const ::rtl::OUString lcl_aServiceName(
 234     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart.Legend" ));
 235
 236 enum
 237 {
 238     PROP_LEGEND_ALIGNMENT
 239 };
 240
 241 void lcl_AddPropertiesToVector(
 242     ::std::vector< Property > & rOutProperties )
 243 {
 244     rOutProperties.push_back(
 245         Property( C2U( "Alignment" ),
 246                   PROP_LEGEND_ALIGNMENT,
 247                   ::getCppuType( reinterpret_cast< const ::com::sun::star::chart::ChartLegendPosition * >(0)),
 248                   beans::PropertyAttribute::BOUND
 249                   | beans::PropertyAttribute::MAYBEDEFAULT ));
 250 }
 251
 252 const Sequence< Property > & lcl_GetPropertySequence()
 253 {
 254     static Sequence< Property > aPropSeq;
 255
 256     // /--
 257     MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
 258     if( 0 == aPropSeq.getLength() )
 259     {
 260         // get properties
 261         ::std::vector< ::com::sun::star::beans::Property > aProperties;
 262         lcl_AddPropertiesToVector( aProperties );
 263         ::chart::CharacterProperties::AddPropertiesToVector( aProperties );
 264         ::chart::LineProperties::AddPropertiesToVector( aProperties );
 265         ::chart::FillProperties::AddPropertiesToVector( aProperties );
 266 //         ::chart::NamedProperties::AddPropertiesToVector( aProperties );
 267         ::chart::UserDefinedProperties::AddPropertiesToVector( aProperties );
 268         ::chart::wrapper::WrappedAutomaticPositionProperties::addProperties( aProperties );
 269         ::chart::wrapper::WrappedScaleTextProperties::addProperties( aProperties );
 270
 271         // and sort them for access via bsearch
 272         ::std::sort( aProperties.begin(), aProperties.end(),
 273                      ::chart::PropertyNameLess() );
 274
 275         // transfer result to static Sequence
 276         aPropSeq = ::chart::ContainerHelper::ContainerToSequence( aProperties );
 277     }
 278
 279     return aPropSeq;
 280 }
 281 } // anonymous namespace
 282
 283 // --------------------------------------------------------------------------------
 284 // --------------------------------------------------------------------------------
 285
 286 namespace chart
 287 {
 288 namespace wrapper
 289 {
 290
 291 LegendWrapper::LegendWrapper( ::boost::shared_ptr< Chart2ModelContact > spChart2ModelContact ) :
 292         m_spChart2ModelContact( spChart2ModelContact ),
 293         m_aEventListenerContainer( m_aMutex )
 294 {
 295 }
 296
 297 LegendWrapper::~LegendWrapper()
 298 {
 299 }
 300
 301 // ____ XShape ____
 302 awt::Point SAL_CALL LegendWrapper::getPosition()
 303     throw (uno::RuntimeException)
 304 {
 305     return m_spChart2ModelContact->GetLegendPosition();
 306 }
 307
 308 void SAL_CALL LegendWrapper::setPosition( const awt::Point& aPosition )
 309     throw (uno::RuntimeException)
 310 {
 311     Reference< beans::XPropertySet > xProp( this->getInnerPropertySet() );
 312     if( xProp.is() )
 313     {
 314         awt::Size aPageSize( m_spChart2ModelContact->GetPageSize() );
 315
 316         chart2::RelativePosition aRelativePosition;
 317         aRelativePosition.Anchor = drawing::Alignment_TOP_LEFT;
 318         aRelativePosition.Primary = double(aPosition.X)/double(aPageSize.Width);
 319         aRelativePosition.Secondary = double(aPosition.Y)/double(aPageSize.Height);
 320         xProp->setPropertyValue( C2U( "RelativePosition" ), uno::makeAny(aRelativePosition) );
 321     }
 322 }
 323
 324 awt::Size SAL_CALL LegendWrapper::getSize()
 325     throw (uno::RuntimeException)
 326 {
 327     return m_spChart2ModelContact->GetLegendSize();
 328 }
 329
 330 void SAL_CALL LegendWrapper::setSize( const awt::Size& aSize )
 331     throw (beans::PropertyVetoException,
 332            uno::RuntimeException)
 333 {
 334     Reference< beans::XPropertySet > xProp( this->getInnerPropertySet() );
 335     if( xProp.is() )
 336     {
 337         awt::Size aPageSize( m_spChart2ModelContact->GetPageSize() );
 338         awt::Rectangle aPageRectangle( 0,0,aPageSize.Width,aPageSize.Height);
 339
 340         awt::Point aPos( this->getPosition() );
 341         awt::Rectangle aNewPositionAndSize(aPos.X,aPos.Y,aSize.Width,aSize.Height);
 342
 343         PositionAndSizeHelper::moveObject( OBJECTTYPE_LEGEND
 344                 , xProp, aNewPositionAndSize, aPageRectangle );
 345     }
 346 }
 347
 348 // ____ XShapeDescriptor (base of XShape) ____
 349 ::rtl::OUString SAL_CALL LegendWrapper::getShapeType()
 350     throw (uno::RuntimeException)
 351 {
 352     return C2U( "com.sun.star.chart.ChartLegend" );
 353 }
 354
 355 // ____ XComponent ____
 356 void SAL_CALL LegendWrapper::dispose()
 357     throw (uno::RuntimeException)
 358 {
 359     Reference< uno::XInterface > xSource( static_cast< ::cppu::OWeakObject* >( this ) );
 360     m_aEventListenerContainer.disposeAndClear( lang::EventObject( xSource ) );
 361
 362     // /--
 363     MutexGuard aGuard( GetMutex());
 364     clearWrappedPropertySet();
 365     // \--
 366 }
 367
 368 void SAL_CALL LegendWrapper::addEventListener(
 369     const Reference< lang::XEventListener >& xListener )
 370     throw (uno::RuntimeException)
 371 {
 372     m_aEventListenerContainer.addInterface( xListener );
 373 }
 374
 375 void SAL_CALL LegendWrapper::removeEventListener(
 376     const Reference< lang::XEventListener >& aListener )
 377     throw (uno::RuntimeException)
 378 {
 379     m_aEventListenerContainer.removeInterface( aListener );
 380 }
 381
 382 // ================================================================================
 383
 384 //ReferenceSizePropertyProvider
 385 void LegendWrapper::updateReferenceSize()
 386 {
 387     Reference< beans::XPropertySet > xProp( this->getInnerPropertySet(), uno::UNO_QUERY );
 388     if( xProp.is() )
 389     {
 390         if( xProp->getPropertyValue( C2U("ReferencePageSize") ).hasValue() )
 391             xProp->setPropertyValue( C2U("ReferencePageSize"), uno::makeAny(
 392                 m_spChart2ModelContact->GetPageSize() ));
 393     }
 394 }
 395 Any LegendWrapper::getReferenceSize()
 396 {
 397     Any aRet;
 398     Reference< beans::XPropertySet > xProp( this->getInnerPropertySet(), uno::UNO_QUERY );
 399     if( xProp.is() )
 400         aRet = xProp->getPropertyValue( C2U("ReferencePageSize") );
 401
 402     return aRet;
 403 }
 404 awt::Size LegendWrapper::getCurrentSizeForReference()
 405 {
 406     return m_spChart2ModelContact->GetPageSize();
 407 }
 408
 409 // ================================================================================
 410
 411 // WrappedPropertySet
 412 Reference< beans::XPropertySet > LegendWrapper::getInnerPropertySet()
 413 {
 414     Reference< beans::XPropertySet > xRet;
 415     Reference< chart2::XDiagram > xDiagram( m_spChart2ModelContact->getChart2Diagram() );
 416     if( xDiagram.is() )
 417         xRet.set( xDiagram->getLegend(), uno::UNO_QUERY );
 418     OSL_ENSURE(xRet.is(),"LegendWrapper::getInnerPropertySet() is NULL");
 419     return xRet;
 420 }
 421
 422 const Sequence< beans::Property >& LegendWrapper::getPropertySequence()
 423 {
 424     return lcl_GetPropertySequence();
 425 }
 426
 427 const std::vector< WrappedProperty* > LegendWrapper::createWrappedProperties()
 428 {
 429     ::std::vector< ::chart::WrappedProperty* > aWrappedProperties;
 430
 431     aWrappedProperties.push_back( new WrappedLegendAlignmentProperty() );
 432     WrappedCharacterHeightProperty::addWrappedProperties( aWrappedProperties, this );
 433     //same problem as for wall: thje defaults ion the old chart are different for different charttypes, so we need to export explicitly
 434     aWrappedProperties.push_back( new WrappedDirectStateProperty( C2U("FillStyle"), C2U("FillStyle") ) );
 435     aWrappedProperties.push_back( new WrappedDirectStateProperty( C2U("FillColor"), C2U("FillColor") ));
 436     WrappedAutomaticPositionProperties::addWrappedProperties( aWrappedProperties );
 437     WrappedScaleTextProperties::addWrappedProperties( aWrappedProperties, m_spChart2ModelContact );
 438
 439     return aWrappedProperties;
 440 }
 441
 442 // ================================================================================
 443
 444 Sequence< ::rtl::OUString > LegendWrapper::getSupportedServiceNames_Static()
 445 {
 446     Sequence< ::rtl::OUString > aServices( 4 );
 447     aServices[ 0 ] = C2U( "com.sun.star.chart.ChartLegend" );
 448     aServices[ 1 ] = C2U( "com.sun.star.drawing.Shape" );
 449     aServices[ 2 ] = C2U( "com.sun.star.xml.UserDefinedAttributeSupplier" );
 450     aServices[ 3 ] = C2U( "com.sun.star.style.CharacterProperties" );
 451 //     aServices[ 4 ] = C2U( "com.sun.star.beans.PropertySet" );
 452 //     aServices[ 5 ] = C2U( "com.sun.star.drawing.FillProperties" );
 453 //     aServices[ 6 ] = C2U( "com.sun.star.drawing.LineProperties" );
 454
 455     return aServices;
 456 }
 457
 458 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 459 APPHELPER_XSERVICEINFO_IMPL( LegendWrapper, lcl_aServiceName );
 460
 461 } //  namespace wrapper
 462 } //  namespace chart