#120527# - [QA TASK]Write test scripts about Presentation Shape via UNO API

Patch by: Wang Li Feng
Review by:Liu Zhe

test/testuno/source/testlib/uno/PageUtil.java

+/**************************************************************
+ *
+ * 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
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+package testlib.uno;
+
+import com.sun.star.uno.UnoRuntime;
+import com.sun.star.lang.XComponent;
+import com.sun.star.lang.XServiceInfo;
+
+import com.sun.star.awt.Size;
+
+import com.sun.star.beans.XPropertySet;
+
+import com.sun.star.drawing.XDrawPage;
+import com.sun.star.drawing.XDrawPages;
+import com.sun.star.drawing.XDrawPagesSupplier;
+import com.sun.star.drawing.XMasterPageTarget;
+import com.sun.star.drawing.XMasterPagesSupplier;
+
+import com.sun.star.presentation.XPresentationPage;
+import com.sun.star.presentation.XHandoutMasterSupplier;
+
+public class PageUtil {
+    /**
+     * Get the page count for standard pages
+     *
+     * @param xComponent
+     *            : The presentation document
+     * @return slide count
+     */
+    static public int getDrawPageCount(XComponent xComponent) {
+        XDrawPagesSupplier xDrawPagesSupplier = (XDrawPagesSupplier) UnoRuntime
+                .queryInterface(XDrawPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
+        return xDrawPages.getCount();
+    }
+
+    /**
+     * Get draw page by index
+     *
+     * @param xComponent
+     *            : The presentation document
+     * @param nIndex
+     *            : index of slide pages, from 0 or 1?
+     * @return Page of corresponding index.
+     */
+    static public XDrawPage getDrawPageByIndex(XComponent xComponent, int nIndex)
+            throws com.sun.star.lang.IndexOutOfBoundsException,
+            com.sun.star.lang.WrappedTargetException {
+        XDrawPagesSupplier xDrawPagesSupplier = (XDrawPagesSupplier) UnoRuntime
+                .queryInterface(XDrawPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
+        return (XDrawPage) UnoRuntime.queryInterface(XDrawPage.class,
+                xDrawPages.getByIndex(nIndex));
+    }
+
+    /**
+     * Create and insert a draw page into the giving position,the method returns
+     * the new created page
+     *
+     * @param xComponent
+     *            :The Presentation Document
+     * @param nIndex
+     *            :The index at which page will be inserted.
+     * @return The newly created page.
+     */
+    static public XDrawPage insertNewDrawPageByIndex(XComponent xComponent,
+            int nIndex) throws Exception {
+        XDrawPagesSupplier xDrawPagesSupplier = (XDrawPagesSupplier) UnoRuntime
+                .queryInterface(XDrawPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
+        return xDrawPages.insertNewByIndex(nIndex);
+    }
+
+    /**
+     * Remove the given page
+     *
+     * @param xComponent
+     *            : The Presentation Document
+     * @param xDrawPage
+     *            : The page want to be removed.
+     */
+    static public void removeDrawPage(XComponent xComponent, XDrawPage xDrawPage) {
+        XDrawPagesSupplier xDrawPagesSupplier = (XDrawPagesSupplier) UnoRuntime
+                .queryInterface(XDrawPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
+        xDrawPages.remove(xDrawPage);
+    }
+
+    /**
+     * Get size of the given page
+     *
+     * @param xDrawPage
+     *            : The specified target page
+     * @return specifies the 2-dimensional size of the page using width and
+     *         height.
+     */
+    static public Size getPageSize(XDrawPage xDrawPage)
+            throws com.sun.star.beans.UnknownPropertyException,
+            com.sun.star.lang.WrappedTargetException {
+        XPropertySet xPageProperties = (XPropertySet) UnoRuntime
+                .queryInterface(XPropertySet.class, xDrawPage);
+        return new Size(
+                ((Integer) xPageProperties.getPropertyValue("Width"))
+                        .intValue(),
+                ((Integer) xPageProperties.getPropertyValue("Height"))
+                        .intValue());
+    }
+
+    /**
+     * Get the page count for master pages
+     *
+     * @param xComponent
+     *            : The presentation document
+     * @return Count of master pages.
+     */
+    static public int getMasterPageCount(XComponent xComponent) {
+        XMasterPagesSupplier xMasterPagesSupplier = (XMasterPagesSupplier) UnoRuntime
+                .queryInterface(XMasterPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
+        return xDrawPages.getCount();
+    }
+
+    /**
+     * Get master page by index
+     *
+     * @param xComponent
+     *            : The Presentation document
+     * @param nIndex
+     *            : Index of target master page.
+     * @return Page of
+     */
+    static public XDrawPage getMasterPageByIndex(XComponent xComponent,
+            int nIndex) throws com.sun.star.lang.IndexOutOfBoundsException,
+            com.sun.star.lang.WrappedTargetException {
+        XMasterPagesSupplier xMasterPagesSupplier = (XMasterPagesSupplier) UnoRuntime
+                .queryInterface(XMasterPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
+        return (XDrawPage) UnoRuntime.queryInterface(XDrawPage.class,
+                xDrawPages.getByIndex(nIndex));
+    }
+
+    /**
+     * creates and inserts a new master page into the giving position, the
+     * method returns the new created page
+     */
+    static public XDrawPage insertNewMasterPageByIndex(XComponent xComponent,
+            int nIndex) {
+        XMasterPagesSupplier xMasterPagesSupplier = (XMasterPagesSupplier) UnoRuntime
+                .queryInterface(XMasterPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
+        return xDrawPages.insertNewByIndex(nIndex);
+    }
+
+    /**
+     * removes the given page
+     */
+    static public void removeMasterPage(XComponent xComponent,
+            XDrawPage xDrawPage) {
+        XMasterPagesSupplier xMasterPagesSupplier = (XMasterPagesSupplier) UnoRuntime
+                .queryInterface(XMasterPagesSupplier.class, xComponent);
+        XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
+        xDrawPages.remove(xDrawPage);
+    }
+
+    /**
+     * return the corresponding masterpage for the giving drawpage
+     */
+    static public XDrawPage getMasterPage(XDrawPage xDrawPage) {
+        XMasterPageTarget xMasterPageTarget = (XMasterPageTarget) UnoRuntime
+                .queryInterface(XMasterPageTarget.class, xDrawPage);
+        return xMasterPageTarget.getMasterPage();
+    }
+
+    /**
+     * sets given masterpage at the drawpage
+     */
+    static public void setMasterPage(XDrawPage xDrawPage, XDrawPage xMasterPage) {
+        XMasterPageTarget xMasterPageTarget = (XMasterPageTarget) UnoRuntime
+                .queryInterface(XMasterPageTarget.class, xDrawPage);
+        xMasterPageTarget.setMasterPage(xMasterPage);
+    }
+
+    // __________ presentation pages __________
+
+    /**
+     * test if a Presentation Document is supported. This is important, because
+     * only presentation documents have notes and handout pages
+     */
+    static public boolean isImpressDocument(XComponent xComponent) {
+        XServiceInfo xInfo = (XServiceInfo) UnoRuntime.queryInterface(
+                XServiceInfo.class, xComponent);
+        return xInfo
+                .supportsService("com.sun.star.presentation.PresentationDocument");
+    }
+
+    /**
+     * in impress documents each normal draw page has a corresponding notes page
+     */
+    static public XDrawPage getNotesPage(XDrawPage xDrawPage) {
+        XPresentationPage aPresentationPage = (XPresentationPage) UnoRuntime
+                .queryInterface(XPresentationPage.class, xDrawPage);
+        return aPresentationPage.getNotesPage();
+    }
+
+    /**
+     * in impress each documents has one handout page
+     */
+    static public XDrawPage getHandoutMasterPage(XComponent xComponent) {
+        XHandoutMasterSupplier aHandoutMasterSupplier = (XHandoutMasterSupplier) UnoRuntime
+                .queryInterface(XHandoutMasterSupplier.class, xComponent);
+        return aHandoutMasterSupplier.getHandoutMasterPage();
+    }
+}

test/testuno/source/testlib/uno/ShapeUtil.java

+package testlib.uno;
+
+/**************************************************************
+ *
+ * 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
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+
+// __________ Imports __________
+
+import com.sun.star.uno.Exception;
+import com.sun.star.uno.UnoRuntime;
+import com.sun.star.lang.XComponent;
+import com.sun.star.lang.XMultiServiceFactory;
+
+import com.sun.star.awt.Point;
+import com.sun.star.awt.Size;
+
+import com.sun.star.beans.XPropertySet;
+
+import com.sun.star.container.XEnumeration;
+import com.sun.star.container.XEnumerationAccess;
+
+import com.sun.star.drawing.XShape;
+import com.sun.star.drawing.XShapes;
+
+import com.sun.star.text.ControlCharacter;
+import com.sun.star.text.XText;
+import com.sun.star.text.XTextCursor;
+import com.sun.star.text.XTextContent;
+import com.sun.star.text.XTextRange;
+
+public class ShapeUtil {
+    // __________ static helper methods __________
+    //
+    public static XPropertySet createAndInsertShape(XComponent xDrawDoc,
+            XShapes xShapes, Point aPos, Size aSize, String sShapeType)
+            throws java.lang.Exception {
+        XShape xShape = createShape(xDrawDoc, aPos, aSize, sShapeType);
+        xShapes.add(xShape);
+        XPropertySet xPropSet = (XPropertySet) UnoRuntime.queryInterface(
+                XPropertySet.class, xShape);
+        return xPropSet;
+    }
+
+    /**
+     * create a Shape
+     */
+    public static XShape createShape(XComponent xDrawDoc, Point aPos,
+            Size aSize, String sShapeType) throws java.lang.Exception {
+        XShape xShape = null;
+        XMultiServiceFactory xFactory = (XMultiServiceFactory) UnoRuntime
+                .queryInterface(XMultiServiceFactory.class, xDrawDoc);
+        Object xObj = xFactory.createInstance(sShapeType);
+        xShape = (XShape) UnoRuntime.queryInterface(XShape.class, xObj);
+        xShape.setPosition(aPos);
+        xShape.setSize(aSize);
+        return xShape;
+    }
+
+    /**
+     * try to get shape according position
+     *
+     * @param aPos
+     * @return
+     */
+    public static XShape getShape(XComponent xDrawDoc, Point aPos,
+            String sShapeType) {
+        XShape xShape = null;
+        try {
+            XMultiServiceFactory xFactory = (XMultiServiceFactory) UnoRuntime
+                    .queryInterface(XMultiServiceFactory.class, xDrawDoc);
+            Object xObj = xFactory.createInstance(sShapeType);
+            xShape = (XShape) UnoRuntime.queryInterface(XShape.class, xObj);
+        } catch (Exception e) {
+            // TODO Auto-generated catch block
+            e.printStackTrace();
+        }
+        return xShape;
+    }
+
+    /**
+     * add text to a shape. the return value is the PropertySet of the text
+     * range that has been added
+     */
+    public static XPropertySet addPortion(XShape xShape, String sText,
+            boolean bNewParagraph)
+            throws com.sun.star.lang.IllegalArgumentException {
+        XText xText = (XText) UnoRuntime.queryInterface(XText.class, xShape);
+
+        XTextCursor xTextCursor = xText.createTextCursor();
+        xTextCursor.gotoEnd(false);
+        if (bNewParagraph == true) {
+            xText.insertControlCharacter(xTextCursor,
+                    ControlCharacter.PARAGRAPH_BREAK, false);
+            xTextCursor.gotoEnd(false);
+        }
+        XTextRange xTextRange = (XTextRange) UnoRuntime.queryInterface(
+                XTextRange.class, xTextCursor);
+        xTextRange.setString(sText);
+        xTextCursor.gotoEnd(true);
+        XPropertySet xPropSet = (XPropertySet) UnoRuntime.queryInterface(
+                XPropertySet.class, xTextRange);
+        return xPropSet;
+    }
+
+    /**
+     * try to get text of a shape
+     *
+     * @return
+     */
+    public static String getPortion(XShape xShape) {
+        String text = null;
+        XText xText = (XText) UnoRuntime.queryInterface(XText.class, xShape);
+
+        XTextCursor xTextCursor = xText.createTextCursor();
+        XTextRange xTextRange = (XTextRange) UnoRuntime.queryInterface(
+                XTextRange.class, xTextCursor);
+        text = xTextRange.getString();
+        return text;
+
+    }
+
+    public static void setPropertyForLastParagraph(XShape xText,
+            String sPropName, Object aValue)
+            throws com.sun.star.beans.UnknownPropertyException,
+            com.sun.star.beans.PropertyVetoException,
+            com.sun.star.lang.IllegalArgumentException,
+            com.sun.star.lang.WrappedTargetException,
+            com.sun.star.container.NoSuchElementException {
+        XEnumerationAccess xEnumerationAccess = (XEnumerationAccess) UnoRuntime
+                .queryInterface(XEnumerationAccess.class, xText);
+        if (xEnumerationAccess.hasElements()) {
+            XEnumeration xEnumeration = xEnumerationAccess.createEnumeration();
+            while (xEnumeration.hasMoreElements()) {
+                Object xObj = xEnumeration.nextElement();
+                if (xEnumeration.hasMoreElements() == false) {
+                    XTextContent xTextContent = (XTextContent) UnoRuntime
+                            .queryInterface(XTextContent.class, xObj);
+                    XPropertySet xParaPropSet = (XPropertySet) UnoRuntime
+                            .queryInterface(XPropertySet.class, xTextContent);
+                    xParaPropSet.setPropertyValue(sPropName, aValue);
+                }
+            }
+        }
+    }
+}