odk/examples/DevelopersGuide/Charts/JavaSampleChartAddIn.java

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  the BSD license.
   5  *
   6  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *  All rights reserved.
   8  *
   9  *  Redistribution and use in source and binary forms, with or without
  10  *  modification, are permitted provided that the following conditions
  11  *  are met:
  12  *  1. Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *  2. Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in the
  16  *     documentation and/or other materials provided with the distribution.
  17  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  18  *     contributors may be used to endorse or promote products derived
  19  *     from this software without specific prior written permission.
  20  *
  21  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  29  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  30  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  31  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  *************************************************************************/
  34
  35 import com.sun.star.uno.UnoRuntime;
  36 import com.sun.star.container.XIndexAccess;
  37 import com.sun.star.lib.uno.helper.WeakBase;
  38
  39 // factories
  40 import com.sun.star.lang.XMultiServiceFactory;
  41 import com.sun.star.lang.XSingleServiceFactory;
  42
  43 // graphics stuff
  44 import com.sun.star.drawing.*;
  45 import com.sun.star.awt.Point;
  46 import com.sun.star.awt.Size;
  47
  48 // chart stuff
  49 import com.sun.star.chart.*;
  50
  51 // property access
  52 import com.sun.star.beans.*;
  53
  54 // Add-In stuff
  55 import com.sun.star.lang.XInitialization;
  56 import com.sun.star.util.XRefreshable;
  57 import com.sun.star.lang.XServiceName;
  58 import com.sun.star.lang.XServiceInfo;
  59 // Exceptions
  60 import com.sun.star.uno.Exception;
  61 import com.sun.star.uno.RuntimeException;
  62
  63 import javax.swing.JOptionPane;
  64
  65 public class JavaSampleChartAddIn extends WeakBase implements
  66     XInitialization,
  67     XRefreshable,
  68     XDiagram,
  69     XServiceName,
  70     XServiceInfo
  71 {
  72
  73     // __________ interface methods __________
  74
  75     // XInitialization
  76     public void initialize( Object[] aArguments )
  77         throws Exception, RuntimeException
  78     {
  79         if( aArguments.length > 0 )
  80         {
  81             maChartDocument = UnoRuntime.queryInterface(
  82                 XChartDocument.class, aArguments[ 0 ]);
  83
  84             XPropertySet aDocProp = UnoRuntime.queryInterface(
  85                 XPropertySet.class, maChartDocument );
  86             if( aDocProp != null )
  87             {
  88                 // set base diagram which will be extended in refresh()
  89                 aDocProp.setPropertyValue( "BaseDiagram", "com.sun.star.chart.XYDiagram" );
  90             }
  91
  92             // get the draw page
  93             XDrawPageSupplier aPageSupp = UnoRuntime.queryInterface(
  94                 XDrawPageSupplier.class, maChartDocument );
  95             if( aPageSupp != null )
  96                 maDrawPage = UnoRuntime.queryInterface(
  97                     XDrawPage.class, aPageSupp.getDrawPage() );
  98
  99             // get a factory for creating shapes
 100             maShapeFactory = UnoRuntime.queryInterface(
 101                 XMultiServiceFactory.class, maChartDocument );
 102         }
 103     }
 104
 105     // XRefreshable
 106     public void refresh() throws RuntimeException
 107     {
 108         // recycle shapes in first call, if document was loaded
 109         if( maBottomLine == null ||
 110             maTopLine == null )
 111         {
 112             // try to recycle loaded shapes
 113             XPropertySet aDocProp = UnoRuntime.queryInterface(
 114                 XPropertySet.class, maChartDocument );
 115             if( aDocProp != null )
 116             {
 117                 try
 118                 {
 119                     XIndexAccess aShapesIA = UnoRuntime.queryInterface(
 120                         XIndexAccess.class, aDocProp.getPropertyValue( "AdditionalShapes" ));
 121                     if( aShapesIA != null &&
 122                         aShapesIA.getCount() > 0 )
 123                     {
 124                         XShape aShape;
 125                         String aName;
 126                         for( int i = aShapesIA.getCount() - 1; i >= 0; --i )
 127                         {
 128                             aShape = UnoRuntime.queryInterface(
 129                                 XShape.class, aShapesIA.getByIndex( i ));
 130                             if( aShape != null )
 131                             {
 132                                 XPropertySet aProp = UnoRuntime.queryInterface(
 133                                     XPropertySet.class, aShape );
 134                                 aName = (String) aProp.getPropertyValue( "Name" );
 135
 136                                 if( aName.equals( "top" ))
 137                                 {
 138                                     maTopLine = aShape;
 139                                 }
 140                                 else if( aName.equals( "bottom" ))
 141                                 {
 142                                     maBottomLine = aShape;
 143                                 }
 144                             }
 145                         }
 146                     }
 147                 }
 148                 catch( Exception ex )
 149                 {
 150                     JOptionPane.showMessageDialog( null, ex, "Exception caught", JOptionPane.WARNING_MESSAGE );
 151                 }
 152             }
 153         }
 154
 155         // create top line if it does not yet exist
 156         try
 157         {
 158             if( maTopLine == null )
 159             {
 160                 maTopLine = UnoRuntime.queryInterface(
 161                     XShape.class, maShapeFactory.createInstance( "com.sun.star.drawing.LineShape" ));
 162                 maDrawPage.add( maTopLine );
 163
 164                 // make line red and thicker
 165                 XPropertySet aShapeProp = UnoRuntime.queryInterface(
 166                     XPropertySet.class, maTopLine );
 167
 168                 aShapeProp.setPropertyValue( "LineColor", Integer.valueOf( 0xe01010 ));
 169                 aShapeProp.setPropertyValue( "LineWidth", Integer.valueOf( 50 ));
 170                 aShapeProp.setPropertyValue( "Name", "top" );
 171             }
 172         }
 173         catch( Exception ex )
 174         {
 175             JOptionPane.showMessageDialog( null, ex, "Exception caught", JOptionPane.WARNING_MESSAGE );
 176         }
 177
 178         // create bottom line if it does not yet exist
 179         try
 180         {
 181             if( maBottomLine == null )
 182             {
 183                 maBottomLine = UnoRuntime.queryInterface(
 184                     XShape.class, maShapeFactory.createInstance( "com.sun.star.drawing.LineShape" ));
 185                 maDrawPage.add( maBottomLine );
 186
 187                 // make line green and thicker
 188                 XPropertySet aShapeProp = UnoRuntime.queryInterface(
 189                     XPropertySet.class, maBottomLine );
 190
 191                 aShapeProp.setPropertyValue( "LineColor", Integer.valueOf( 0x10e010 ));
 192                 aShapeProp.setPropertyValue( "LineWidth", Integer.valueOf( 50 ));
 193                 aShapeProp.setPropertyValue( "Name", "bottom" );
 194             }
 195         }
 196         catch( Exception ex )
 197         {
 198             JOptionPane.showMessageDialog( null, ex, "Exception caught", JOptionPane.WARNING_MESSAGE );
 199         }
 200
 201         if( maTopLine == null ||
 202             maBottomLine == null )
 203         {
 204             JOptionPane.showMessageDialog( null, "One of the lines is still null", "Assertion", JOptionPane.WARNING_MESSAGE );
 205             return;
 206         }
 207
 208         // position lines
 209
 210
 211         // get data
 212         XChartDataArray aDataArray = UnoRuntime.queryInterface(
 213             XChartDataArray.class, maChartDocument.getData());
 214         double aData[][] = aDataArray.getData();
 215
 216         // get axes
 217         XDiagram aDiagram = maChartDocument.getDiagram();
 218         XShape aXAxis = UnoRuntime.queryInterface(
 219             XShape.class, UnoRuntime.queryInterface(
 220                                XAxisXSupplier.class, aDiagram ).getXAxis() );
 221         XShape aYAxis = UnoRuntime.queryInterface(
 222             XShape.class, UnoRuntime.queryInterface(
 223                                XAxisYSupplier.class, aDiagram ).getYAxis() );
 224
 225         // calculate points for hull
 226         final int nLength = aData.length;
 227         int i, j;
 228         double fMax, fMin;
 229
 230         Point aMaxPtSeq[][] = new Point[ 1 ][];
 231         aMaxPtSeq[ 0 ] = new Point[ nLength ];
 232         Point aMinPtSeq[][] = new Point[ 1 ][];
 233         aMinPtSeq[ 0 ] = new Point[ nLength ];
 234
 235         for( i = 0; i < nLength; i++ )
 236         {
 237             fMin = fMax = aData[ i ][ 1 ];
 238             for( j = 1; j < aData[ i ].length; j++ )
 239             {
 240                 if( aData[ i ][ j ] > fMax )
 241                     fMax = aData[ i ][ j ];
 242                 else if( aData[ i ][ j ] < fMin )
 243                     fMin = aData[ i ][ j ];
 244             }
 245             aMaxPtSeq[ 0 ][ i ] = new Point( getAxisPosition( aXAxis, aData[ i ][ 0 ], false ),
 246                                              getAxisPosition( aYAxis, fMax, true ));
 247             aMinPtSeq[ 0 ][ i ] = new Point( getAxisPosition( aXAxis, aData[ i ][ 0 ], false ),
 248                                              getAxisPosition( aYAxis, fMin, true ));
 249         }
 250
 251         // apply point sequences to lines
 252         try
 253         {
 254             XPropertySet aShapeProp = UnoRuntime.queryInterface(
 255                 XPropertySet.class, maTopLine );
 256             aShapeProp.setPropertyValue( "PolyPolygon", aMaxPtSeq );
 257
 258             aShapeProp = UnoRuntime.queryInterface(
 259                 XPropertySet.class, maBottomLine );
 260             aShapeProp.setPropertyValue( "PolyPolygon", aMinPtSeq );
 261         }
 262         catch( Exception ex )
 263         {
 264             JOptionPane.showMessageDialog( null, ex, "Exception caught", JOptionPane.WARNING_MESSAGE );
 265         }
 266     }
 267
 268     public void addRefreshListener( com.sun.star.util.XRefreshListener aListener )
 269         throws RuntimeException
 270     {
 271         // we don't want this but we have to implement the interface
 272     }
 273
 274     public void removeRefreshListener( com.sun.star.util.XRefreshListener aListener )
 275         throws RuntimeException
 276     {
 277         // we don't want this but we have to implement the interface
 278     }
 279
 280
 281     // XServiceName
 282     public String getServiceName() throws RuntimeException
 283     {
 284         return smServiceName;
 285     }
 286
 287     // XServiceInfo
 288     public boolean supportsService( String aServiceName )
 289     {
 290         String[] aServices = getSupportedServiceNames_Static();
 291         int i, nLength = aServices.length;
 292         boolean bResult = false;
 293
 294         for( i = 0; !bResult && i < nLength; ++i )
 295             bResult = aServiceName.equals( aServices[ i ] );
 296
 297         return bResult;
 298     }
 299
 300     public String getImplementationName()
 301     {
 302         return( JavaSampleChartAddIn.class.getName() );
 303     }
 304
 305     public String[] getSupportedServiceNames()
 306     {
 307         return getSupportedServiceNames_Static();
 308     }
 309
 310     // XDiagram
 311     public String getDiagramType() throws RuntimeException
 312     {
 313         return smServiceName;
 314     }
 315
 316     public XPropertySet getDataRowProperties( int nRow )
 317         throws com.sun.star.lang.IndexOutOfBoundsException, RuntimeException
 318     {
 319         return maChartDocument.getDiagram().getDataRowProperties( nRow );
 320     }
 321
 322     public XPropertySet getDataPointProperties( int nCol, int nRow )
 323         throws com.sun.star.lang.IndexOutOfBoundsException, RuntimeException
 324     {
 325         return maChartDocument.getDiagram().getDataPointProperties( nCol, nRow );
 326     }
 327
 328     // XShape : XDiagram
 329     public Size getSize() throws RuntimeException
 330     {
 331         return UnoRuntime.queryInterface( XShape.class, maChartDocument.getDiagram()).getSize();
 332     }
 333     public void setSize( Size aSize ) throws RuntimeException, PropertyVetoException
 334     {
 335         UnoRuntime.queryInterface( XShape.class, maChartDocument.getDiagram()).setSize( aSize );
 336     }
 337
 338     public Point getPosition() throws RuntimeException
 339     {
 340         return UnoRuntime.queryInterface( XShape.class, maChartDocument.getDiagram()).getPosition();
 341     }
 342     public void setPosition( Point aPos ) throws RuntimeException
 343     {
 344         UnoRuntime.queryInterface( XShape.class, maChartDocument.getDiagram()).setPosition( aPos );
 345     }
 346
 347     // XShapeDescriptor : XShape : XDiagram
 348     public String getShapeType() throws RuntimeException
 349     {
 350         return "com.sun.star.comp.Chart.JavaSampleDiagramShape";
 351     }
 352
 353
 354     // __________ private members __________
 355     private com.sun.star.chart.XChartDocument       maChartDocument;
 356     private com.sun.star.drawing.XDrawPage          maDrawPage;
 357     private com.sun.star.lang.XMultiServiceFactory  maShapeFactory;
 358
 359     // shapes added by add-in
 360     private com.sun.star.drawing.XShape             maTopLine;
 361     private com.sun.star.drawing.XShape             maBottomLine;
 362
 363     // __________ private methods __________
 364
 365     private int getAxisPosition( XShape aAxis, double fValue, boolean bVertical )
 366     {
 367         int nResult = 0;
 368
 369         if( aAxis != null )
 370         {
 371             XPropertySet aAxisProp = UnoRuntime.queryInterface(
 372                 XPropertySet.class, aAxis );
 373
 374             try
 375             {
 376                 double fMin, fMax;
 377                 fMin = ((Double) aAxisProp.getPropertyValue( "Min" )).doubleValue();
 378                 fMax = ((Double) aAxisProp.getPropertyValue( "Max" )).doubleValue();
 379                 double fRange = fMax - fMin;
 380
 381                 if( fMin <= fValue && fValue <= fMax &&
 382                     fRange != 0 )
 383                 {
 384                     if( bVertical )
 385                     {
 386                         nResult = aAxis.getPosition().Y +
 387                             (int)((aAxis.getSize().Height) *
 388                                   (1.0 - (( fValue - fMin ) / fRange )));
 389                     }
 390                     else
 391                     {
 392                         nResult = aAxis.getPosition().X +
 393                             (int)((aAxis.getSize().Width) *
 394                                   (( fValue - fMin ) / fRange ));
 395                     }
 396                 }
 397             }
 398             catch( Exception ex )
 399             {
 400                 JOptionPane.showMessageDialog( null, ex, "Exception caught", JOptionPane.WARNING_MESSAGE );
 401             }
 402         }
 403         return nResult;
 404     }
 405
 406     // __________ static things __________
 407
 408     private static final String smServiceName  = "com.sun.star.comp.Chart.JavaSampleChartAddIn";
 409
 410     public static String[] getSupportedServiceNames_Static()
 411     {
 412         String[] aResult = { smServiceName,
 413                              "com.sun.star.chart.Diagram",
 414                              "com.sun.star.chart.ChartAxisYSupplier" };
 415         return aResult;
 416     }
 417
 418
 419     /**
 420      * Returns a factory for creating the service.
 421      * This method is called by the <code>JavaLoader</code>
 422      * <p>
 423      * @return  returns a <code>XSingleServiceFactory</code> for creating the component
 424      * @param   implName     the name of the implementation for which a service is desired
 425      * @param   multiFactory the service manager to be used if needed
 426      * @param   regKey       the registryKey
 427      * @see                  com.sun.star.comp.loader.JavaLoader
 428      */
 429     public static XSingleServiceFactory __getServiceFactory(
 430         String implName,
 431         XMultiServiceFactory multiFactory,
 432         com.sun.star.registry.XRegistryKey regKey )
 433     {
 434         XSingleServiceFactory xSingleServiceFactory = null;
 435
 436         if( implName.equals( JavaSampleChartAddIn.class.getName()) )
 437         {
 438             xSingleServiceFactory = com.sun.star.comp.loader.FactoryHelper.getServiceFactory(
 439                 JavaSampleChartAddIn.class, smServiceName,
 440                 multiFactory,  regKey );
 441         }
 442
 443         return xSingleServiceFactory;
 444     }
 445
 446 }