summaryrefslogtreecommitdiff
path: root/testautomation/extensions/optional/input/extension_sources/TaskPaneComponent/src/com/example/ToolPanelUIElement.java
blob: fe4ee300d29de1122f7cb53f46ab6cbdf13359d0 (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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*************************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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 com.example;

import com.sun.star.awt.XContainerWindowProvider;
import com.sun.star.awt.XWindow;
import com.sun.star.awt.XWindowPeer;
import com.sun.star.deployment.PackageInformationProvider;
import com.sun.star.deployment.XPackageInformationProvider;
import com.sun.star.frame.XFrame;
import com.sun.star.lang.DisposedException;
import com.sun.star.lang.XComponent;
import com.sun.star.lib.uno.helper.ComponentBase;
import com.sun.star.ui.UIElementType;
import com.sun.star.ui.XUIElement;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 *
 * @author frank.schoenheit@oracle.com
 */
public class ToolPanelUIElement extends ComponentBase implements XUIElement
{
    
    protected final XFrame          m_docFrame;
    protected final XWindow         m_parentWindow;
    private XWindow                 m_panelRootWindow = null;
    private Object                  m_toolPanel = null;
    XComponentContext context = null;
    
    
    protected ToolPanelUIElement( XComponentContext _context, final XFrame i_docFrame, final XWindow i_parentWindow )
    {
        context = _context;
        m_docFrame = i_docFrame;
        m_parentWindow = i_parentWindow;
    }

    public static String getResourceURLBase()
    {
        return "private:resource/toolpanel/com.example.TaskPaneComponent/";
    }

    // XUIElement overridables
    public XFrame getFrame()            { return m_docFrame; }
    public short getType()              { return UIElementType.TOOLPANEL; }
    public String getResourceURL()      { return getResourceURLBase() + getPanelResourceURLSuffix(); }

    public Object getRealInterface()
    {
        synchronized( this )
        {
            if ( this.bDisposed || this.bInDispose )
                throw new DisposedException( new String(), this );

            if ( m_toolPanel == null )
                m_toolPanel = new ToolPanel( getOrCreatePanelRootWindow() );
        }
        return m_toolPanel;
    }

    // own overridables
    /** returns the name of the dialog description file of the tool panel, without .xdl suffix
     */
    protected String getPanelResourceLocation()
    {
        return "TaskPaneComponentUI";

    }

    /** returns the resource URL suffix to use for the tool panel
     * @return
     */
    protected String getPanelResourceURLSuffix()
    {
        return "TaskPaneComponentUI";
    }
    

    // ComponentBase overridables
    protected void postDisposing()
    {
        super.postDisposing();
        synchronized ( this )
        {
            if ( m_panelRootWindow != null )
            {
                XComponent panelWindowComp = UnoRuntime.queryInterface( XComponent.class, m_panelRootWindow );
                panelWindowComp.dispose();
                m_panelRootWindow = null;
             
            }
            m_toolPanel = null;
        }
    }

    // helpers
    synchronized private XWindow getOrCreatePanelRootWindow()
    {
        try
        {
            XPackageInformationProvider pip = PackageInformationProvider.get(context);
            String s = pip.getPackageLocation("com.example.TaskPaneComponent");

            String dialogUrl = s + "/toolpanels/" + getPanelResourceLocation() + ".xdl";

            XContainerWindowProvider provider = UnoRuntime.queryInterface(
                XContainerWindowProvider.class,
                context.getServiceManager().createInstanceWithContext("com.sun.star.awt.ContainerWindowProvider",context)
            );

            m_panelRootWindow = provider.createContainerWindow(
                dialogUrl,
                "",
                UnoRuntime.queryInterface( XWindowPeer.class, m_parentWindow ),
                null
            );
            
        }
        catch ( final Exception e )
        {
            Logger.getLogger( ToolPanelUIElement.class.getName() ).log( Level.SEVERE, null, e );
        }
        return m_panelRootWindow;
    }
}