/*
* 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.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.SOfficeFactory;
import com.sun.star.container.XNameAccess;
import com.sun.star.lang.XComponent;
import com.sun.star.sheet.XSheetAnnotation;
import com.sun.star.sheet.XSheetAnnotationAnchor;
import com.sun.star.sheet.XSheetAnnotationsSupplier;
import com.sun.star.sheet.XSpreadsheet;
import com.sun.star.sheet.XSpreadsheetDocument;
import com.sun.star.sheet.XSpreadsheets;
import com.sun.star.table.XCell;
import com.sun.star.table.XCellRange;
import com.sun.star.text.XSimpleText;
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 represents a collection of annotations
* for a spreadsheet document (implements
* com.sun.star.sheet.CellAnnotations
).
* Object implements the following interfaces : *
com::sun::star::container::XIndexAccess
com::sun::star::container::XElementAccess
com::sun::star::sheet::XSheetAnnotations
* This object test is NOT designed to be run in several
* threads concurrently.
* @see com.sun.star.sheet.CellAnnotations
* @see com.sun.star.container.XIndexAccess
* @see com.sun.star.container.XElementAccess
* @see com.sun.star.sheet.XSheetAnnotations
* @see ifc.container._XIndexAccess
* @see ifc.container._XElementAccess
* @see ifc.sheet._XSheetAnnotations
*/
public class ScAnnotationsObj extends TestCase {
private XSpreadsheetDocument xSheetDoc = null;
/**
* Creates Spreadsheet document.
*/
@Override
protected void initialize( TestParameters tParam, PrintWriter log ) throws Exception {
SOfficeFactory SOF = SOfficeFactory.getFactory( tParam.getMSF() );
log.println( "creating a Spreadsheet document" );
xSheetDoc = SOF.createCalcDoc(null);
}
/**
* Disposes Spreadsheet document.
*/
@Override
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.
* From a document collection of spreadsheets a single one is
* retrieved and one annotation is added to it. Then a collection
* of annotations is retrieved using spreadsheet's
* com.sun.star.sheet.XSheetAnnotationsSupplier
interface.
*/
@Override
protected TestEnvironment createTestEnvironment(TestParameters Param, PrintWriter log) throws Exception {
// 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 ") ;
XSpreadsheetDocument xSpreadsheetDoc = UnoRuntime.queryInterface(XSpreadsheetDocument.class, xSheetDoc);
XSpreadsheets sheets = xSpreadsheetDoc.getSheets();
XNameAccess oNames = UnoRuntime.queryInterface( XNameAccess.class, sheets );
XCell oCell = null;
XSpreadsheet oSheet = null;
oSheet = (XSpreadsheet) AnyConverter.toObject(
new Type(XSpreadsheet.class),
oNames.getByName(oNames.getElementNames()[0]));
// adding an annotation...
XCellRange oCRange = UnoRuntime.queryInterface(XCellRange.class, oSheet);
oCell = oCRange.getCellByPosition(10,10);
XSheetAnnotationAnchor oAnnoA = UnoRuntime.queryInterface(XSheetAnnotationAnchor.class, oCell);
XSheetAnnotation oAnno = oAnnoA.getAnnotation();
XSimpleText sText = UnoRuntime.queryInterface(XSimpleText.class, oAnno);
sText.setString("ScAnnotationsObj");
XSheetAnnotationsSupplier supp = UnoRuntime.queryInterface(
XSheetAnnotationsSupplier.class, oSheet);
XInterface oObj = supp.getAnnotations();
TestEnvironment tEnv = new TestEnvironment( oObj );
return tEnv;
}
} // finish class ScAnnotationsObj