odk/examples/DevelopersGuide/Charts/ChartInCalc.java

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: ChartInCalc.java,v $
   4  *
   5  *  $Revision: 1.4 $
   6  *
   7  *  last change: $Author: hr $ $Date: 2007-07-31 13:53:35 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 // __________ Imports __________
  42
  43 // base classes
  44 import com.sun.star.uno.XInterface;
  45 import com.sun.star.uno.UnoRuntime;
  46 import com.sun.star.lang.*;
  47
  48 // property access
  49 import com.sun.star.beans.*;
  50
  51 // application specific classes
  52 import com.sun.star.chart.*;
  53 import com.sun.star.drawing.*;
  54
  55 import com.sun.star.table.CellRangeAddress;
  56 import com.sun.star.table.XCellRange;
  57 import com.sun.star.sheet.XCellRangeAddressable;
  58
  59 import com.sun.star.frame.XModel;
  60 import com.sun.star.frame.XController;
  61
  62 import com.sun.star.util.XNumberFormatsSupplier;
  63 import com.sun.star.util.XNumberFormats;
  64
  65 // base graphics things
  66 import com.sun.star.awt.Point;
  67 import com.sun.star.awt.Size;
  68 import com.sun.star.awt.Rectangle;
  69 import com.sun.star.awt.FontWeight;
  70 import com.sun.star.awt.FontRelief;
  71
  72 // Exceptions
  73 import com.sun.star.uno.Exception;
  74 import com.sun.star.uno.RuntimeException;
  75 import com.sun.star.beans.UnknownPropertyException;
  76 import com.sun.star.lang.IndexOutOfBoundsException;
  77 import com.sun.star.util.MalformedNumberFormatException;
  78
  79
  80 // __________ Implementation __________
  81
  82 /** Create a spreadsheet add some data and add a chart
  83     @author Bj&ouml;rn Milcke
  84  */
  85 public class ChartInCalc
  86 {
  87     // ____________________
  88
  89     public static void main( String args[] )
  90     {
  91         Helper aHelper = new Helper( args );
  92
  93         CalcHelper aCalcHelper = new CalcHelper( aHelper.createSpreadsheetDocument() );
  94
  95         // insert a cell range with 4 columns and 24 rows filled with random numbers
  96         XCellRange aRange = aCalcHelper.insertRandomRange( 4, 24 );
  97         CellRangeAddress aRangeAddress = ((XCellRangeAddressable) UnoRuntime.queryInterface(
  98             XCellRangeAddressable.class, aRange)).getRangeAddress();
  99
 100         // change view to sheet containing the chart
 101         aCalcHelper.raiseChartSheet();
 102
 103         // the unit for measures is 1/100th of a millimeter
 104         // position at (1cm, 1cm)
 105         Point aPos    = new Point( 1000, 1000 );
 106
 107         // size of the chart is 15cm x 9.271cm
 108         Size  aExtent = new Size( 15000, 9271 );
 109
 110         // insert a new chart into the "Chart" sheet of the
 111         // spreadsheet document
 112         XChartDocument aChartDoc = aCalcHelper.insertChart(
 113             "ScatterChart",
 114             aRangeAddress,
 115             aPos,
 116             aExtent,
 117             "com.sun.star.chart.XYDiagram" );
 118
 119         // instantiate test class with newly created chart
 120         ChartInCalc aTest   = new ChartInCalc( aChartDoc );
 121
 122         try
 123         {
 124             aTest.lockControllers();
 125
 126             aTest.testDiagram();
 127             aTest.testArea();
 128             aTest.testWall();
 129             aTest.testTitle();
 130             aTest.testAxis();
 131             aTest.testGrid();
 132
 133             // show an intermediate state, ...
 134             aTest.unlockControllers();
 135             aTest.lockControllers();
 136
 137             // ..., because the following takes a while:
 138             // an internet URL has to be resolved
 139             aTest.testDataRowProperties();
 140             aTest.testDataPointProperties();
 141
 142             aTest.unlockControllers();
 143         }
 144         catch( Exception ex )
 145         {
 146             System.out.println( "UNO Exception caught: " + ex );
 147             System.out.println( "Message: " + ex.getMessage() );
 148         }
 149
 150         System.exit( 0 );
 151     }
 152
 153
 154     // ________________________________________
 155
 156     public ChartInCalc( XChartDocument aChartDoc )
 157     {
 158         maChartDocument = aChartDoc;
 159         maDiagram       = maChartDocument.getDiagram();
 160     }
 161
 162     // ____________________
 163
 164     public void lockControllers()
 165         throws RuntimeException
 166     {
 167         ((XModel) UnoRuntime.queryInterface( XModel.class, maChartDocument )).lockControllers();
 168     }
 169
 170     // ____________________
 171
 172     public void unlockControllers()
 173         throws RuntimeException
 174     {
 175         ((XModel) UnoRuntime.queryInterface( XModel.class, maChartDocument )).unlockControllers();
 176     }
 177
 178     // ____________________
 179
 180     public void testDiagram()
 181         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 182                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 183     {
 184         XPropertySet aDiaProp = (XPropertySet) UnoRuntime.queryInterface( XPropertySet.class, maDiagram );
 185
 186         if( aDiaProp != null )
 187         {
 188             // change chart type
 189             aDiaProp.setPropertyValue( "Lines", new Boolean( true ));
 190
 191             // change attributes for all series
 192             // set line width to 0.5mm
 193             aDiaProp.setPropertyValue( "LineWidth",  new Integer( 50 ));
 194         }
 195     }
 196
 197     // ____________________
 198
 199     public void testDataRowProperties()
 200         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 201                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 202     {
 203         // change properties of the data series
 204         try
 205         {
 206             XPropertySet aSeriesProp;
 207             for( int i = 1; i <= 3; i++ )
 208             {
 209                 aSeriesProp = maDiagram.getDataRowProperties( i );
 210                 aSeriesProp.setPropertyValue( "LineColor", new Integer(
 211                                                   0x400000 * i +
 212                                                   0x005000 * i +
 213                                                   0x0000ff - 0x40 * i ));
 214                 if( 1 == i )
 215                 {
 216                     StringBuffer sUrl = new StringBuffer("file:///");
 217                     try {
 218                         /* for use without net it's easier to load a local graphic */
 219                         java.io.File sourceFile = new java.io.File("bullet.gif");
 220                         sUrl.append(sourceFile.getCanonicalPath().replace('\\', '/'));
 221                     } catch (java.io.IOException e) {
 222                         sUrl = new StringBuffer("http://graphics.openoffice.org/chart/bullet1.gif");
 223                     }
 224
 225                     // set a bitmap via URL as symbol for the first series
 226                     aSeriesProp.setPropertyValue( "SymbolType", new Integer( ChartSymbolType.BITMAPURL ));
 227                     aSeriesProp.setPropertyValue( "SymbolBitmapURL", sUrl.toString() );
 228                 }
 229                 else
 230                 {
 231                     aSeriesProp.setPropertyValue( "SymbolType", new Integer( ChartSymbolType.SYMBOL1 ));
 232                     aSeriesProp.setPropertyValue( "SymbolSize", new Size( 250, 250 ));
 233                 }
 234             }
 235         }
 236         catch( IndexOutOfBoundsException ex )
 237         {
 238             System.out.println( "Oops, there not enough series for setting properties: " + ex );
 239         }
 240     }
 241
 242     // ____________________
 243
 244     public void testDataPointProperties()
 245         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 246                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 247     {
 248         // set properties for a single data point
 249         try
 250         {
 251             // determine the maximum value of the first series
 252             int nMaxIndex = 0;
 253
 254             XChartDataArray aDataArray = (XChartDataArray) UnoRuntime.queryInterface(
 255                 XChartDataArray.class, maChartDocument.getData());
 256             double aData[][] = aDataArray.getData();
 257
 258             int i;
 259             double fMax = aData[ 0 ][ 1 ];
 260             for( i = 1; i < aData.length; i++ )
 261             {
 262                 if( aData[ i ][ 1 ] > fMax )
 263                 {
 264                     fMax = aData[ i ][ 1 ];
 265                     nMaxIndex = i;
 266                 }
 267             }
 268
 269             // first parameter is the index of the point, the second one is the series
 270             XPropertySet aPointProp = maDiagram.getDataPointProperties( 0, 1 );
 271
 272             // set a different, larger symbol
 273             aPointProp.setPropertyValue( "SymbolType", new Integer( ChartSymbolType.SYMBOL6 ));
 274             aPointProp.setPropertyValue( "SymbolSize", new Size( 600, 600 ));
 275
 276             // add a label text with bold font, bordeaux red 14pt
 277             aPointProp.setPropertyValue( "DataCaption", new Integer( ChartDataCaption.VALUE ));
 278             aPointProp.setPropertyValue( "CharHeight",  new Float( 14.0 ));
 279             aPointProp.setPropertyValue( "CharColor",   new Integer( 0x993366 ));
 280             aPointProp.setPropertyValue( "CharWeight",  new Float( FontWeight.BOLD ));
 281         }
 282         catch( IndexOutOfBoundsException ex )
 283         {
 284             System.out.println( "Oops, there not enough data points or series for setting properties: " + ex );
 285         }
 286     }
 287
 288     // ____________________
 289
 290     public void testArea()
 291         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 292                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 293     {
 294         XPropertySet   aArea = maChartDocument.getArea();
 295
 296         if( aArea != null )
 297         {
 298             // change background color of entire chart
 299             aArea.setPropertyValue( "FillStyle", FillStyle.SOLID );
 300             aArea.setPropertyValue( "FillColor", new Integer( 0xeeeeee ));
 301         }
 302     }
 303
 304     // ____________________
 305
 306     public void testWall()
 307         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 308                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 309     {
 310         XPropertySet aWall = ((X3DDisplay) UnoRuntime.queryInterface(
 311                                   X3DDisplay.class, maDiagram )).getWall();
 312
 313         // change background color of area
 314         aWall.setPropertyValue( "FillStyle", FillStyle.SOLID );
 315         aWall.setPropertyValue( "FillColor", new Integer( 0xcccccc ));
 316     }
 317
 318     // ____________________
 319
 320     public void testTitle()
 321         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 322                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 323     {
 324         // change main title
 325         XPropertySet aDocProp = (XPropertySet) UnoRuntime.queryInterface(
 326             XPropertySet.class, maChartDocument );
 327         aDocProp.setPropertyValue( "HasMainTitle", new Boolean( true ));
 328
 329         XShape aTitle = maChartDocument.getTitle();
 330         XPropertySet aTitleProp = (XPropertySet) UnoRuntime.queryInterface( XPropertySet.class, aTitle );
 331
 332         // set new text
 333         if( aTitleProp != null )
 334         {
 335             aTitleProp.setPropertyValue( "String", "Random Scatter Chart" );
 336             aTitleProp.setPropertyValue( "CharHeight", new Float(14.0) );
 337         }
 338
 339         // align title with y axis
 340         XShape aAxis = (XShape) UnoRuntime.queryInterface(
 341             XShape.class, ((XAxisYSupplier) UnoRuntime.queryInterface(
 342                 XAxisYSupplier.class, maDiagram )).getYAxis() );
 343
 344         if( aAxis != null &&
 345             aTitle != null )
 346         {
 347             Point aPos = aTitle.getPosition();
 348             aPos.X = ( aAxis.getPosition() ).X;
 349             aTitle.setPosition( aPos );
 350         }
 351     }
 352
 353     // ____________________
 354
 355     public void testAxis()
 356         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 357                com.sun.star.lang.IllegalArgumentException, WrappedTargetException,
 358                MalformedNumberFormatException
 359     {
 360         // x axis
 361         XPropertySet aAxisProp = ((XAxisXSupplier) UnoRuntime.queryInterface(
 362                                       XAxisXSupplier.class, maDiagram )).getXAxis();
 363         if( aAxisProp != null )
 364         {
 365             aAxisProp.setPropertyValue( "Max",      new Integer( 24 ));
 366             aAxisProp.setPropertyValue( "StepMain", new Integer( 3 ));
 367         }
 368
 369         // change number format for y axis
 370         aAxisProp = ((XAxisYSupplier) UnoRuntime.queryInterface(
 371                          XAxisYSupplier.class, maDiagram )).getYAxis();
 372
 373         // add a new custom number format and get the new key
 374         int nNewNumberFormat = 0;
 375         XNumberFormatsSupplier aNumFmtSupp = (XNumberFormatsSupplier) UnoRuntime.queryInterface(
 376             XNumberFormatsSupplier.class, maChartDocument );
 377
 378         if( aNumFmtSupp != null )
 379         {
 380             XNumberFormats aFormats = aNumFmtSupp.getNumberFormats();
 381             Locale aLocale = new Locale( "de", "DE", "de" );
 382
 383             String aFormatStr = aFormats.generateFormat( nNewNumberFormat, aLocale, true, true, (short)3, (short)1 );
 384             nNewNumberFormat = aFormats.addNew( aFormatStr, aLocale );
 385         }
 386
 387         if( aAxisProp != null )
 388         {
 389             aAxisProp.setPropertyValue( "NumberFormat", new Integer( nNewNumberFormat ));
 390         }
 391     }
 392
 393     // ____________________
 394
 395     public void testGrid()
 396         throws RuntimeException, UnknownPropertyException, PropertyVetoException,
 397                com.sun.star.lang.IllegalArgumentException, WrappedTargetException
 398     {
 399         // y major grid
 400         XPropertySet aGridProp = (XPropertySet) UnoRuntime.queryInterface(
 401             XPropertySet.class,
 402             ( (XAxisYSupplier) UnoRuntime.queryInterface(
 403                 XAxisYSupplier.class, maDiagram )).getYMainGrid());
 404
 405         if( aGridProp != null )
 406         {
 407             LineDash aDash = new LineDash();
 408             aDash.Style    = DashStyle.ROUND;
 409             aDash.Dots     = 2;
 410             aDash.DotLen   = 10;
 411             aDash.Dashes   = 1;
 412             aDash.DashLen  = 200;
 413             aDash.Distance = 100;
 414
 415             aGridProp.setPropertyValue( "LineColor", new Integer( 0x999999 ));
 416             aGridProp.setPropertyValue( "LineStyle", LineStyle.DASH );
 417             aGridProp.setPropertyValue( "LineDash", aDash );
 418             aGridProp.setPropertyValue( "LineWidth", new Integer( 30 ));
 419         }
 420     }
 421
 422
 423     // ______________________________
 424     //
 425     // private members
 426     // ______________________________
 427
 428     private XChartDocument maChartDocument;
 429     private XDiagram       maDiagram;
 430 }