summaryrefslogtreecommitdiff
path: root/scripting/java/com/sun/star/script/framework/provider/ScriptContext.java
blob: 546755e9e93ac931e6d2901d706b2988257bf705 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
 * 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 com.sun.star.script.framework.provider;

import com.sun.star.document.XScriptInvocationContext;
import com.sun.star.frame.XModel;
import com.sun.star.frame.XDesktop;
import com.sun.star.uno.XComponentContext;
import com.sun.star.lang.XMultiComponentFactory;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.beans.PropertyAttribute;
import com.sun.star.lib.uno.helper.PropertySet;
import com.sun.star.uno.Type;

import com.sun.star.script.provider.XScriptContext;

import com.sun.star.script.framework.log.LogUtils;

public class ScriptContext extends PropertySet implements XScriptContext {
    private final static String HM_DOC_REF = "DocumentReference";
    private final static String HM_DESKTOP = "Desktop";
    private final static String HM_COMPONENT_CONTEXT = "ComponentContext";

    private final static String DOC_URI = "SCRIPTING_DOC_URI";


    private XModel m_xModel = null;
    private XScriptInvocationContext m_xInvocationContext = null;

    private XDesktop m_xDeskTop = null;

    private XComponentContext m_xComponentContext = null;

    private ScriptContext(XComponentContext xmComponentContext,
                          XDesktop xDesktop, XModel xModel, XScriptInvocationContext xInvocContext) {
        this.m_xDeskTop = xDesktop;
        this.m_xComponentContext = xmComponentContext;
        this.m_xModel = xModel;
        this.m_xInvocationContext = xInvocContext;

        if (m_xModel != null) {
            registerProperty(DOC_URI, new Type(String.class),
                             (short)(PropertyAttribute.MAYBEVOID | PropertyAttribute.TRANSIENT),
                             "m_sDocURI");
        }

        registerProperty(HM_DOC_REF, new Type(XModel.class),
                         (short)(PropertyAttribute.MAYBEVOID | PropertyAttribute.TRANSIENT), "m_xModel");
        registerProperty(HM_DESKTOP, new Type(XDesktop.class),
                         (short)(PropertyAttribute.MAYBEVOID | PropertyAttribute.TRANSIENT),
                         "m_xDeskTop");
        registerProperty(HM_COMPONENT_CONTEXT, new Type(XDesktop.class),
                         (short)(PropertyAttribute.MAYBEVOID | PropertyAttribute.TRANSIENT),
                         "m_xComponentContext");
    }

    public static XScriptContext createContext(XModel xModel,
            XScriptInvocationContext xInvocContext,
            XComponentContext xCtxt, XMultiComponentFactory xMCF) {
        XScriptContext sc = null;

        try {

            Object xInterface = xMCF.createInstanceWithContext(
                                    "com.sun.star.frame.Desktop", xCtxt);
            XDesktop xDesktop = UnoRuntime.queryInterface(XDesktop.class, xInterface);

            if (xModel != null) {
                sc = new ScriptContext(xCtxt, xDesktop, xModel, xInvocContext);
            } else {
                sc = new EditorScriptContext(xCtxt, xDesktop);
            }

        } catch (Exception e) {
            LogUtils.DEBUG(LogUtils.getTrace(e));
        }

        return sc;
    }


    /**
        Obtain the document reference on which the script can operate

        @return  XModel interface
    */
    public XModel getDocument() {
        return m_xModel;
    }

    public XScriptInvocationContext getInvocationContext() {
        return m_xInvocationContext;
    }

    /**
        Obtain the desktop reference on which the script can operate

        @return  XDesktop interface
    */
    public XDesktop getDesktop() {
        return m_xDeskTop;
    }

    /**
        Obtain the component context which the script can use to create other uno components

        @return  XComponentContext interface
    */
    public XComponentContext getComponentContext() {
        return m_xComponentContext;
    }

}