/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: _XShape.java,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package ifc.drawing;
import lib.MultiMethodTest;
import com.sun.star.awt.Point;
import com.sun.star.awt.Size;
import com.sun.star.drawing.XShape;
/**
* Testing <code>com.sun.star.drawing.XShape</code>
* interface methods :
* <ul>
* <li><code> getPosition()</code></li>
* <li><code> setPosition()</code></li>
* <li><code> getSize()</code></li>
* <li><code> setSize()</code></li>
* </ul> <p>
* This test needs the following object relations :
* <ul>
* <li> <code>'NoPos'</code> <b>optional</b>
* (of type <code>Object</code>):
* if this relation exists then position setting is
* not supported by the object.</li>
* <ul> <p>
* Test is <b> NOT </b> multithread compilant. <p>
* @see com.sun.star.drawing.XShape
*/
public class _XShape extends MultiMethodTest {
public XShape oObj = null; //oObj filled by MultiMethodTest
Size sOld = new Size();
Point pOld = new Point();
Size sNew = new Size();
Point pNew = new Point();
/**
* Gets the size and stores it. <p>
* Has <b> OK </b> status if the method successfully returns
* and no exceptions were thrown. <p>
*/
public void _getSize(){
boolean result = false;
log.println("get the size");
sOld = (Size) oObj.getSize();
result = true;
tRes.tested("getSize()", result);
}
/**
* Gets the current position and stores it if the object
* supports position setting. <p>
* Has <b> OK </b> status if the method successfully returns
* and no exceptions were thrown or object doesn't
* support position setting. <p>
*/
public void _getPosition(){
boolean result = false;
String obj = (String) tEnv.getObjRelation("NoPos");
if (obj != null) {
log.println("Can't be used with "+obj);
result = true;
tRes.tested("getPosition()", result);
return;
}
log.println("get the position");
pOld = (Point) oObj.getPosition();
result = true;
tRes.tested("getPosition()", result);
}
/**
* Sets a new size different from the size get before. <p>
* Has <b> OK </b> status if the size returned by <code>getSize()</code>
* is equal to the size which was set. <p>
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> getSize() </code> : to set the original size changed.</li>
* </ul>
*/
public void _setSize(){
requiredMethod("getSize()");
boolean result = true;
String obj = (String) tEnv.getObjRelation("NoSetSize");
if (obj != null) {
log.println("Can't be used with " + obj);
tRes.tested("setSize()", true);
return;
}
// get the current thread's holder
sNew = new Size(sOld.Width + 10,sOld.Height + 10) ;
//set new size
log.println("change the size");
try {
oObj.setSize(sNew);
} catch (com.sun.star.beans.PropertyVetoException e) {
log.println("Exception while calling the method :" + e);
result = true ;
}
Size gSize = oObj.getSize() ;
log.println("Previously: "+sOld.Height+";"+sOld.Width);
log.println("Expected: "+sNew.Height+";"+sNew.Width);
log.println("Getting: "+gSize.Height+";"+gSize.Width);
//result &= util.ValueComparer.equalValue(sNew, gSize) ;
//errors in calculation from points/twips less then 1 are acceptable
result &= (sNew.Height-gSize.Height <= 2) && (sNew.Width-gSize.Width <= 2);
if (result && ((sNew.Height-gSize.Height != 0) || (sNew.Width-gSize.Width != 0))){
log.println("NOTE: there is a difference between the expected and the getted value. " +
"This might be ok because of problems in calculation from points <-> twips");
}
tRes.tested("setSize()", result);
}
/**
* If object doesn't support position setting the test does nothing.
* Else a new position is created and set.<p>
* Has <b> OK </b> status if get position is equal to set position or
* if the position setting isn't supported. <p>
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> getPosition() </code> : to change old position. </li>
* </ul>
*/
public void _setPosition(){
requiredMethod("getPosition()");
boolean result = true;
String obj = (String) tEnv.getObjRelation("NoPos");
if (obj != null) {
log.println("Can't be used with " + obj);
tRes.tested("setPosition()", true);
return;
}
// get the current thread's holder
pNew = new Point(pOld.X + 100, pOld.Y + 100) ;
oObj.setPosition(pNew);
Point gPos = oObj.getPosition() ;
log.println("Previously: "+pOld.X+";"+pOld.Y);
log.println("Expected: "+pNew.X+";"+pNew.Y);
log.println("Getting: "+gPos.X+";"+gPos.Y);
result = !util.ValueComparer.equalValue(pOld, gPos) ;
tRes.tested("setPosition()", result);
}
} // finish class _XShape