odk/examples/DevelopersGuide/OfficeDev/Number_Formats.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 // __________ Imports __________
  36
  37 import com.sun.star.beans.PropertyValue;
  38 import com.sun.star.container.XIndexAccess;
  39 import com.sun.star.frame.XComponentLoader;
  40 import com.sun.star.lang.XMultiComponentFactory;
  41 import com.sun.star.sheet.XSpreadsheet;
  42 import com.sun.star.sheet.XSpreadsheets;
  43 import com.sun.star.sheet.XSpreadsheetDocument;
  44 import com.sun.star.table.XCell;
  45 import com.sun.star.uno.UnoRuntime;
  46 import com.sun.star.uno.XComponentContext;
  47
  48
  49 // __________ Implementation __________
  50
  51 /** Create a spreadsheet document and provide access to a sheet framework that
  52     is then used to modify some number formats.
  53  */
  54 public class Number_Formats
  55 {
  56     // __________ public members and methods __________
  57
  58
  59
  60
  61     public static void main( String args[] )
  62     {
  63         try
  64         {
  65             Number_Formats aSample = new Number_Formats( args );
  66             aSample.doFunction();
  67         }
  68         catch( Exception ex )
  69         {
  70             System.err.println( "Sample caught exception! " + ex );
  71             ex.printStackTrace();
  72             System.exit(1);
  73         }
  74
  75         System.out.println( "Sample done." );
  76         System.exit(0);
  77     }
  78
  79
  80
  81     public void doFunction() throws RuntimeException, Exception
  82     {
  83         // Assume:
  84         // com.sun.star.sheet.XSpreadsheetDocument maSpreadsheetDoc;
  85         // com.sun.star.sheet.XSpreadsheet maSheet;
  86
  87         // Query the number formats supplier of the spreadsheet document
  88         com.sun.star.util.XNumberFormatsSupplier xNumberFormatsSupplier =
  89             UnoRuntime.queryInterface(
  90         com.sun.star.util.XNumberFormatsSupplier.class, maSpreadsheetDoc );
  91
  92         // Get the number formats from the supplier
  93         com.sun.star.util.XNumberFormats xNumberFormats =
  94             xNumberFormatsSupplier.getNumberFormats();
  95
  96         // Query the XNumberFormatTypes interface
  97         com.sun.star.util.XNumberFormatTypes xNumberFormatTypes =
  98             UnoRuntime.queryInterface(
  99         com.sun.star.util.XNumberFormatTypes.class, xNumberFormats );
 100
 101         // Get the number format index key of the default currency format,
 102         // note the empty locale for default locale
 103         com.sun.star.lang.Locale aLocale = new com.sun.star.lang.Locale();
 104         int nCurrencyKey = xNumberFormatTypes.getStandardFormat(
 105             com.sun.star.util.NumberFormat.CURRENCY, aLocale );
 106
 107         // Get cell range B3:B11
 108         com.sun.star.table.XCellRange xCellRange =
 109             maSheet.getCellRangeByPosition( 1, 2, 1, 10 );
 110
 111         // Query the property set of the cell range
 112         com.sun.star.beans.XPropertySet xCellProp =
 113             UnoRuntime.queryInterface(
 114         com.sun.star.beans.XPropertySet.class, xCellRange );
 115
 116         // Set number format to default currency
 117         xCellProp.setPropertyValue( "NumberFormat", Integer.valueOf(nCurrencyKey) );
 118
 119         // Get cell B3
 120         com.sun.star.table.XCell xCell = maSheet.getCellByPosition( 1, 2 );
 121
 122         // Query the property set of the cell
 123         xCellProp = UnoRuntime.queryInterface(
 124         com.sun.star.beans.XPropertySet.class, xCell );
 125
 126         // Get the number format index key of the cell's properties
 127         int nIndexKey = ((Integer) xCellProp.getPropertyValue( "NumberFormat" )).intValue();
 128         if ( nIndexKey != nCurrencyKey )
 129             System.out.println( "Number format doesn't match!" );
 130
 131         // Get the properties of the number format
 132         com.sun.star.beans.XPropertySet xProp = xNumberFormats.getByKey( nIndexKey );
 133
 134         // Get the format code string of the number format's properties
 135         String aFormatCode = (String) xProp.getPropertyValue( "FormatString" );
 136         System.out.println( "FormatString: `" + aFormatCode + "'" );
 137
 138         // Create an arbitrary format code
 139         aFormatCode = "\"wonderful \"" + aFormatCode;
 140
 141         // Test if it's already present
 142         nIndexKey = xNumberFormats.queryKey( aFormatCode, aLocale, false );
 143
 144         // If not, add to number formats collection
 145         if ( nIndexKey == -1 )
 146         {
 147             try
 148             {
 149                 nIndexKey = xNumberFormats.addNew( aFormatCode, aLocale );
 150             }
 151             catch( com.sun.star.util.MalformedNumberFormatException ex )
 152             {
 153                 System.err.println( "Bad number format code: " + ex );
 154                 ex.printStackTrace();
 155                 nIndexKey = -1;
 156             }
 157         }
 158
 159         // Set the new format at the cell
 160         if ( nIndexKey != -1 )
 161             xCellProp.setPropertyValue( "NumberFormat", Integer.valueOf(nIndexKey) );
 162
 163
 164         // Set column containing the example values to optimal width to show
 165         // the new format of cell B3
 166         com.sun.star.table.XColumnRowRange xColRowRange =
 167             UnoRuntime.queryInterface(com.sun.star.table.XColumnRowRange.class,
 168                                   maSheet);
 169
 170         com.sun.star.container.XIndexAccess xIndexAccess =
 171             UnoRuntime.queryInterface(com.sun.star.container.XIndexAccess.class,
 172                                   xColRowRange.getColumns());
 173
 174         com.sun.star.beans.XPropertySet xColPropSet =
 175             UnoRuntime.queryInterface(com.sun.star.beans.XPropertySet.class,
 176                                   xIndexAccess.getByIndex(1));
 177
 178         xColPropSet.setPropertyValue( "OptimalWidth", Boolean.TRUE );
 179     }
 180
 181
 182
 183     public Number_Formats( String[] args ) throws java.lang.Exception
 184     {
 185         // get the remote office context. If necessary a new office
 186         // process is started
 187         XComponentContext aOfficeContext = com.sun.star.comp.helper.Bootstrap.bootstrap();
 188         System.out.println("Connected to a running office ...");
 189         XMultiComponentFactory aServiceManager = aOfficeContext.getServiceManager();
 190
 191         // create a new spreadsheet document
 192         XComponentLoader aLoader = UnoRuntime.queryInterface(
 193             XComponentLoader.class, aServiceManager.createInstanceWithContext(
 194                 "com.sun.star.frame.Desktop", aOfficeContext) );
 195
 196         maSpreadsheetDoc = UnoRuntime.queryInterface(
 197             XSpreadsheetDocument.class,
 198             aLoader.loadComponentFromURL( "private:factory/scalc",
 199                                           "_blank",
 200                                           0,
 201                                           new PropertyValue[ 0 ] ) );
 202
 203         if ( !initSpreadsheet() )
 204             System.exit( 0 );
 205     }
 206
 207
 208     // __________ private members and methods __________
 209
 210     private final XSpreadsheetDocument   maSpreadsheetDoc;
 211     private XSpreadsheet           maSheet;  // the first sheet
 212
 213
 214
 215
 216     /** init the first sheet
 217      */
 218     private boolean initSpreadsheet()
 219     {
 220         boolean bOk = true;
 221         XSpreadsheets aSheets = maSpreadsheetDoc.getSheets();
 222         try
 223         {
 224             XIndexAccess aSheetsIA = UnoRuntime.queryInterface( XIndexAccess.class, aSheets );
 225             maSheet = UnoRuntime.queryInterface(XSpreadsheet.class, aSheetsIA.getByIndex( 0 ));
 226
 227             // enter some values in B3:B11
 228             for( int iCounter=1; iCounter < 10; iCounter++ )
 229             {
 230                 XCell aCell = maSheet.getCellByPosition( 1, 1 + iCounter );
 231                 aCell.setValue( iCounter );
 232             }
 233         }
 234         catch( Exception ex )
 235         {
 236             System.err.println( "Couldn't initialize Spreadsheet Document: " + ex );
 237             ex.printStackTrace();
 238             bOk = false;
 239         }
 240         return bOk;
 241     }
 242 }