/*
* 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.XIndexAccess;
import com.sun.star.lang.XComponent;
import com.sun.star.sheet.XSheetAnnotation;
import com.sun.star.sheet.XSheetAnnotationAnchor;
import com.sun.star.sheet.XSpreadsheet;
import com.sun.star.sheet.XSpreadsheetDocument;
import com.sun.star.sheet.XSpreadsheets;
import com.sun.star.table.CellAddress;
import com.sun.star.table.XCell;
import com.sun.star.table.XCellRange;
import com.sun.star.uno.AnyConverter;
import com.sun.star.uno.Type;
import com.sun.star.uno.UnoRuntime;
/**
* Test for object which represents some text annotation
* anchored to some cell in spreadsheet (implement
* com.sun.star.sheet.CellAnnotation
).
* Object implements the following interfaces :
*
* -
com::sun::star::text::XSimpleText
* -
com::sun::star::text::XTextRange
* -
com::sun::star::sheet::XSheetAnnotation
*
* This object test is NOT designed to be run in several
* threads concurrently.
* @see com.sun.star.sheet.CellAnnotation
* @see com.sun.star.text.XSimpleText
* @see com.sun.star.text.XTextRange
* @see com.sun.star.sheet.XSheetAnnotation
* @see ifc.text._XSimpleText
* @see ifc.text._XTextRange
* @see ifc.sheet._XSheetAnnotation
*/
public class ScAnnotationObj extends TestCase {
private XSpreadsheetDocument xSheetDoc = null;
/**
* Creates a 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 a 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.
* Retrieves a collection of spreadsheets from a document,
* and takes one them. Then a single cell is retrieved, and
* using its com.sun.star.sheet.XSheetAnnotationAnchor
* interface an annotation is got.
* Object relations created :
*
* -
'CELLPOS'
for
* {@link ifc.sheet._XSheetAnnotation} (of
* com.sun.star.table.CellAddress
type) which
* contains the annotation cell address.
*
*/
@Override
public 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" );
CellAddress cellPos = new CellAddress((short)0, 1, 2);
log.println("Getting test object ") ;
XSpreadsheetDocument xArea = UnoRuntime.queryInterface(XSpreadsheetDocument.class, xSheetDoc);
XSpreadsheets oSheets = xArea.getSheets();
XIndexAccess XAccess = UnoRuntime.queryInterface(XIndexAccess.class, oSheets);
XCell oCell = null;
XSpreadsheet oSheet = (XSpreadsheet) AnyConverter.toObject(
new Type(XSpreadsheet.class),XAccess.getByIndex(cellPos.Sheet));
XCellRange oCRange = UnoRuntime.queryInterface(XCellRange.class, oSheet);
oCell = oCRange.getCellByPosition(cellPos.Column, cellPos.Row);
XSheetAnnotationAnchor oAnnoA = UnoRuntime.queryInterface(XSheetAnnotationAnchor.class, oCell);
XSheetAnnotation oAnno = oAnnoA.getAnnotation();
TestEnvironment tEnv = new TestEnvironment( oAnno );
tEnv.addObjRelation("CELLPOS", cellPos);
// Other parameters required for interface tests
return tEnv;
}
} // finish class ScAnnotationObj