/*
 * 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._sw;

import java.io.PrintWriter;

import lib.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.InstCreator;
import util.ParagraphDsc;
import util.SOfficeFactory;
import util.TableDsc;

import com.sun.star.beans.XPropertySet;
import com.sun.star.text.XText;
import com.sun.star.text.XTextCursor;
import com.sun.star.text.XTextDocument;
import com.sun.star.text.XTextFrame;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;

/**
 *
 * initial description
 *
 * @see com.sun.star.container.XElementAccess
 * @see com.sun.star.container.XEnumerationAccess
 * @see com.sun.star.text.XSimpleText
 * @see com.sun.star.text.XText
 * @see com.sun.star.text.XTextRange
 * @see com.sun.star.text.XTextRangeMover
 *
 */
public class SwXTextFrameText extends TestCase {
    XTextDocument xTextDoc;

    @Override
    protected void initialize(TestParameters tParam, PrintWriter log) throws Exception {
        SOfficeFactory SOF = SOfficeFactory.getFactory(tParam.getMSF());

        log.println("creating a textdocument");
        xTextDoc = SOF.createTextDoc(null);
    }

    @Override
    protected void cleanup(TestParameters tParam, PrintWriter log) {
        log.println("    disposing xTextDoc ");
        util.DesktopTools.closeDoc(xTextDoc);
    }

    /**
     * creating a TestEnvironment for the interfaces to be tested
     *
     * @param tParam
     *            class which contains additional test parameters
     * @param log
     *            class to log the test state and result
     *
     * @return Status class
     *
     * @see TestParameters
     * @see PrintWriter
     */
    @Override
    public TestEnvironment createTestEnvironment(
            TestParameters tParam, PrintWriter log) throws Exception {

        XInterface oObj = null;
        XTextFrame oFrame1 = null;
        XPropertySet oPropSet = null;
        XText oText = null;
        XTextCursor oCursor = null;

        // creation of testobject here
        // first we write what we are intend to do to log file
        log.println("creating a test environment");

        // get a soffice factory object
        SOfficeFactory.getFactory(tParam.getMSF());

        // create testobject here

        oFrame1 = SOfficeFactory.createTextFrame(xTextDoc, 500, 500);
        oPropSet = UnoRuntime.queryInterface(XPropertySet.class, oFrame1);
        // AnchorTypes: 0 = paragraph, 1 = as char, 2 = page,
        // 3 = frame/paragraph 4= at char
        oPropSet.setPropertyValue("AnchorType", Integer.valueOf(2));
        oText = xTextDoc.getText();
        oCursor = oText.createTextCursor();

        log.println("inserting Frame1");
        oText.insertTextContent(oCursor, oFrame1, false);

        XText oFText = UnoRuntime.queryInterface(XText.class, oFrame1);
        XTextCursor oFCursor = oFText.createTextCursor();
        oFText.insertString(oFCursor, "SwXTextFrameText", false);

        oObj = oFText.getText();

        log.println("creating a new environment for TextFrameText object");
        TestEnvironment tEnv = new TestEnvironment(oObj);

        log.println("adding TextDocument as mod relation to environment");
        tEnv.addObjRelation("TEXT", oObj);

        log.println("adding InstDescriptor object");
        TableDsc tDsc = new TableDsc(6, 4);

        log.println("adding InstCreator object");
        tEnv.addObjRelation("XTEXTINFO", new InstCreator(xTextDoc, tDsc));

        log.println("    adding Paragraph");
        ParagraphDsc pDsc = new ParagraphDsc();
        tEnv.addObjRelation("PARA", new InstCreator(xTextDoc, pDsc));

        return tEnv;
    } // finish method getTestEnvironment

} // finish class SwXTextFrameText