/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package mod._sc;
import java.io.PrintWriter;
import lib.StatusException;
import lib.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.SOfficeFactory;
import com.sun.star.beans.XPropertySet;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.sheet.XNamedRanges;
import com.sun.star.sheet.XSpreadsheetDocument;
import com.sun.star.table.CellAddress;
import com.sun.star.table.CellRangeAddress;
import com.sun.star.uno.AnyConverter;
import com.sun.star.uno.Type;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;
/**
* Test for object which is represented by service
* com.sun.star.sheet.NamedRange
.
* Object implements the following interfaces :
*
* -
com::sun::star::container::XNamed
* -
com::sun::star::sheet::XNamedRange
* -
com::sun::star::sheet::XCellRangeReferrer
*
* @see com.sun.star.sheet.NamedRange
* @see com.sun.star.container.XNamed
* @see com.sun.star.sheet.XNamedRange
* @see com.sun.star.sheet.XCellRangeReferrer
* @see ifc.container._XNamed
* @see ifc.sheet._XNamedRange
* @see ifc.sheet._XCellRangeReferrer
*/
public class ScNamedRangeObj extends TestCase {
private XSpreadsheetDocument xSheetDoc = null;
/**
* Creates Spreadsheet document.
*/
protected void initialize( TestParameters tParam, PrintWriter log ) {
SOfficeFactory SOF = SOfficeFactory.getFactory( (XMultiServiceFactory)tParam.getMSF() );
try {
log.println( "creating a Spreadsheet document" );
xSheetDoc = SOF.createCalcDoc(null);
} catch ( com.sun.star.uno.Exception e ) {
// Some exception occurs.FAILED
e.printStackTrace( log );
throw new StatusException( "Couldn't create document", e );
}
}
/**
* Disposes Spreadsheet document.
*/
protected void cleanup( TestParameters tParam, PrintWriter log ) {
log.println( " disposing xSheetDoc " );
XComponent oComp = UnoRuntime.queryInterface(XComponent.class, xSheetDoc) ;
util.DesktopTools.closeDoc(oComp);
}
/**
* Creating a Testenvironment for the interfaces to be tested.
* Retrieves a collection of spreadsheets from a document
* and takes one of them. Obtains the value of the property
* 'NamedRanges'
that is the collection of named ranges.
* Creates and adds new range to the collection. This new range is the instance of the
* service com.sun.star.sheet.NamedRange
.
* Object relations created :
*
* -
'DATAAREA'
for
* {@link ifc.sheet._XCellRangeReferrer} (the cell range address of the
* created range)
*
*/
protected synchronized TestEnvironment createTestEnvironment(TestParameters Param, PrintWriter log) {
XInterface oObj = null;
// creation of testobject here
// first we write what we are intend to do to log file
log.println( "Creating a test environment" );
log.println("Getting test object ") ;
// Getting named ranges.
XPropertySet docProps = UnoRuntime.queryInterface(XPropertySet.class, xSheetDoc);
Object ranges = null;
try {
ranges = docProps.getPropertyValue("NamedRanges");
} catch(com.sun.star.lang.WrappedTargetException e){
e.printStackTrace(log);
throw new StatusException("Couldn't get NamedRanges", e);
} catch(com.sun.star.beans.UnknownPropertyException e){
e.printStackTrace(log);
throw new StatusException("Couldn't get NamedRanges", e);
}
XNamedRanges xNamedRanges = UnoRuntime.queryInterface(XNamedRanges.class, ranges);
CellRangeAddress DataArea = new CellRangeAddress((short)0, 0, 0, 1, 1);
CellAddress base = new CellAddress(DataArea.Sheet,
DataArea.StartColumn,
DataArea.StartRow);
if (xNamedRanges.hasByName("ANamedRange")) {
xNamedRanges.removeByName("ANamedRange");
}
xNamedRanges.addNewByName("ANamedRange", "A1:B2", base, 0);
CellAddress listOutputPosition = new CellAddress((short)0, 1, 1);
xNamedRanges.outputList(listOutputPosition);
try {
oObj = (XInterface) AnyConverter.toObject(
new Type(XInterface.class),xNamedRanges.getByName("ANamedRange"));
} catch(com.sun.star.lang.WrappedTargetException e){
e.printStackTrace(log);
throw new StatusException("Couldn't get by name", e);
} catch(com.sun.star.container.NoSuchElementException e){
e.printStackTrace(log);
throw new StatusException("Couldn't get by name", e);
} catch(com.sun.star.lang.IllegalArgumentException e){
e.printStackTrace(log);
throw new StatusException("Couldn't get by name", e);
}
TestEnvironment tEnv = new TestEnvironment( oObj );
// Other parameters required for interface tests
tEnv.addObjRelation("DATAAREA", DataArea);
return tEnv;
}
}