Another scenario is that a OOoBean contains a document and is removed from a Java container and later added again. Then aquireSystemWindow needs to be called after the container window is displayed.
@throws SystemWindowException
if no system window can be acquired.
@throws NoConnectionException
if the connection is not established.
*/
public synchronized void aquireSystemWindow()
throws
SystemWindowException,
// @requirement FUNC.CON.LOST/0.2
NoConnectionException
{
if ( iConnection == null )
throw new NoConnectionException();
if ( !isShowing() )
throw new SystemWindowException();
if ( xFrameWindow != null )
xFrameWindow.getAWTComponent().setVisible(true);
doLayout();
}
// @requirement FUNC.PAR.RWL/0.4
// @estimation 16h
/** This method must be called when the OOoBean before the
system window may be released by its parent AWT/Swing component.
This is the case when java.awt.Component.isDisplayable() returns
true. This is definitely the case when the OOoBean is removed
from its parent container.
@throws SystemWindowException
if system window is not acquired.
@throws NoConnectionException
if the connection is not established.
@deprecated When Component.removeNotify of the parent window of the actual
office window is called, then the actions are performed for which this method
needed to be called previously.
*/
public synchronized void releaseSystemWindow()
throws
SystemWindowException,
// @requirement FUNC.CON.LOST/0.2
NoConnectionException
{
if ( iConnection == null )
throw new NoConnectionException();
try { xFrameWindow.getAWTComponent().setVisible(false); }
catch ( com.sun.star.lang.DisposedException aExc )
{ throw new NoConnectionException(); }
}
// @requirement FUNC.BEAN.LOAD/0.4
// @requirement FUNC.CON.AUTO/0.3
/** Loads the bean from the given URL.
If a document is already loaded and the content modified,
the changes are dismissed.
If no connection exists, a default connection is established.
@throws IllegalArgumentException
if either of the arguments is out of the specified range.
@throws java.io.IOException
if an IO error occurs reading the resource specified by the URL.
@throws com.sun.star.lang.NoConnectionException
if no connection can be established.
@throws com.sun.star.util.CloseVetoException
if the currently displayed document cannot be closed because it is
still be used, for example it is printed.
*/
public void loadFromURL(
final String aURL,
final com.sun.star.beans.PropertyValue aArguments[] )
throws
// @requirement FUNC.CON.LOST/0.2
NoConnectionException,
java.io.IOException,
com.sun.star.lang.IllegalArgumentException,
com.sun.star.util.CloseVetoException
{
dbgPrint( "loadFromURL()" );
// try loading
try
{
boolean bLoaded = false;
while ( !bLoaded )
{
// watch loading in a thread with a timeout (if OOo hangs)
CallWatchThread aCallWatchThread =
new CallWatchThread( nOOoStartTimeOut, "loadFromURL" );
try
{
// get window from OOo on demand
if ( xFrameWindow == null )
{
// Establish the connection by request of the ServiceFactory.
getMultiServiceFactory();
// remove existing child windows
removeAll();
// Create the OfficeWindow.
xFrameWindow = getOOoConnection().createOfficeWindow(OOoBean.this);
add( xFrameWindow.getAWTComponent() );
}
// create the document frame from UNO window.
if ( aFrame == null )
{
// create the frame
com.sun.star.awt.XWindow xWindow =
UnoRuntime.queryInterface(
com.sun.star.awt.XWindow.class, xFrameWindow.getUNOWindowPeer());
Object xFrame = xServiceFactory.createInstance( "com.sun.star.frame.Frame");
aFrame = new Frame( UnoRuntime.queryInterface(
com.sun.star.frame.XFrame.class, xFrame ) );
aFrame.initialize( xWindow );
aFrame.setName( aFrame.toString() );
// register the frame at the desktop
com.sun.star.frame.XFrames xFrames =
UnoRuntime.queryInterface(
com.sun.star.frame.XFramesSupplier.class, getOOoDesktop() ).getFrames();
xFrames.append( aFrame );
}
// Initializes the slot command execution environment.
xURLTransformer = UnoRuntime.queryInterface(
com.sun.star.util.XURLTransformer.class,
xServiceFactory.createInstance( "com.sun.star.util.URLTransformer") );
try
{
xDispatcher = UnoRuntime.queryInterface(com.sun.star.frame.XDispatchProvider.class, aFrame);
}
catch (Exception e)
{
/*ignore!*/
}
// get XComponentLoader from frame
com.sun.star.frame.XComponentLoader xLoader = UnoRuntime.queryInterface( com.sun.star.frame.XComponentLoader.class, aFrame );
if ( xLoader == null )
{
throw new java.lang.RuntimeException(
"com.sun.star.frame.Frame(" + aFrame +
") without com.sun.star.frame.XComponentLoader" );
}
// Avoid dialog 'Document changed' while reloading
if ( aDocument != null )
{
try {
aDocument.setModified(false);
} catch (com.sun.star.beans.PropertyVetoException ep) {
// it doesn't make sense to throw the exception here. The interface does not
// offer a way to add/remove respective listeners.
} catch (com.sun.star.lang.DisposedException ed) {
// can be disposed if user closed document via UI
}
com.sun.star.frame.XController xOldController = null;
if ( aFrame != null )
xOldController = aFrame.getController();
try
{
if ( aFrame != null && xOldController != null )
if (!xOldController.suspend(true))
throw new com.sun.star.util.CloseVetoException(
"Dokument is still being used and cannot be closed.", this);
}
catch (java.lang.IllegalStateException exp)
{}
}
// load the document.
com.sun.star.beans.PropertyValue aArgs[] =
addArgument( aArguments, new com.sun.star.beans.PropertyValue(
"MacroExecutionMode", -1,
Short.valueOf( com.sun.star.document.MacroExecMode.USE_CONFIG ),
com.sun.star.beans.PropertyState.DIRECT_VALUE ) );
com.sun.star.lang.XComponent xComponent = xLoader.loadComponentFromURL(
aURL, "_self", 0, aArgs );
// nothing loaded?
if ( xComponent == null && aDocument != null )
{
// reactivate old document
if ( aFrame != null && aFrame.getController() != null )
aFrame.getController().suspend(false);
aDocument.setModified(true);
// throw exception
throw new java.io.IOException(
"Can not load a document: \"" + aURL + "\"");
}
// Get document's XModifiable interface if any.
aDocument = new OfficeDocument(
UnoRuntime.queryInterface(
com.sun.star.frame.XModel.class, xComponent ) );
bLoaded = true;
}
catch ( NoConnectionException aExc )
{
// stop, clear and retry
stopOOoConnection();
}
catch ( com.sun.star.lang.DisposedException aExc )
{
// stop, clear and retry
stopOOoConnection();
}
catch ( com.sun.star.uno.Exception aExc )
{
// TDB: handling failure in createInstance
aExc.printStackTrace();
throw new java.io.IOException();
}
aCallWatchThread.cancel();
if ( xServiceFactory == null )
throw new NoConnectionException();
}
if ( iConnection == null )
{
throw new NoConnectionException();
}
applyToolVisibilities();
}
catch ( InterruptedException aExc )
{
throw new NoConnectionException();
}
}
// @requirement FUNC.BEAN.PROG/0.5
// @requirement API.SIM.SEAP/0.2
/** returns the
If an older OOoBean instance is used with a newer OOo instance,
some tool bars might not be affected by this method.
If no connection is established or no document is loaded,
the setting is memorized until a document is loaded. Same
is valid when the connection dies within this function call.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. For example:
If not connected or no document loaded, the value is stored
and automatically applied to the document after it is loaded.
Same is valid when the connection dies within this function call.
@param bVisible
If false, the menu bar is disabled,
If true, the menu bar is visible.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public void setMenuBarVisible(boolean bVisible)
{
try
{
bMenuBarVisible = setToolVisible( "MenuBarVisible",
"private:resource/menubar/menubar", bMenuBarVisible, bVisible );
}
catch ( InterruptedException aExc )
{
bMenuBarVisible = bVisible;
}
}
/** Returns the visibility of the menu bar.
This method works independently from a connection or loaded document.
If no connection is established or no document is loaded,
this method just returns a memorized status.
@return
True if the menu bar is visible,
false if the menu bar is hidden.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public boolean isMenuBarVisible()
{
return bMenuBarVisible;
}
/** Sets the main function bar visibilty.
Initially the standard bar is visible.
If not connected or no document loaded, the value is stored
and automatically applied to the document after it is loaded.
Same is valid when the connection dies within this function call.
@param bVisible
If false, the main function bar is disabled,
If true, the main function bar is visible.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public void setStandardBarVisible(boolean bVisible)
{
try
{
bStandardBarVisible = setToolVisible( "StandardBarVisible",
"private:resource/toolbar/standardbar", bStandardBarVisible, bVisible );
}
catch ( InterruptedException aExc )
{
bMenuBarVisible = bVisible;
}
}
/** Returns the visibility of the main function bar.
This method works independently from a connection or loaded document.
If no connection is established or no document is loaded,
this method just returns a memorized status.
@return
True if the main function bar is visible,
false if the main function bar is hidden.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public boolean isStandardBarVisible()
{
return bStandardBarVisible;
}
/** Sets the tool function bar visibilty.
Initially the tool bar is visible.
If not connected or no document loaded, the value is stored
and automatically applied to the document after it is loaded.
Same is valid when the connection dies within this function call.
@param bVisible
If false, the tool function bar is disabled,
If true, the tool function bar is visible.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public void setToolBarVisible(boolean bVisible)
{
try
{
bToolBarVisible = setToolVisible( "ToolBarVisible",
"private:resource/toolbar/toolbar", bToolBarVisible, bVisible );
}
catch ( InterruptedException aExc )
{
bMenuBarVisible = bVisible;
}
}
/** Returns the visibility of the tool function bar.
This method works independently from a conneiction or loaded document.
If no connection is established or no document is loaded,
this method just returns a memorized status.
@return
True if the tool function bar is visible,
false if the tool function bar is hidden.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public boolean isToolBarVisible()
{
return bToolBarVisible;
}
/** Sets the status function bar visibilty.
Initially the status bar is visible.
If not connected or no document loaded, the value is stored
and automatically applied to the document after it is loaded.
Same is valid when the connection dies within this function call.
@param bVisible
If false, the status function bar is disabled,
If true, the status function bar is visible.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public void setStatusBarVisible(boolean bVisible)
{
try
{
bStatusBarVisible = setToolVisible( "StatusBarVisible",
"private:resource/statusbar/statusbar", bStatusBarVisible, bVisible );
}
catch ( InterruptedException aExc )
{
bMenuBarVisible = bVisible;
}
}
/** Returns the visibility of the status function bar.
This method works independently from a connection or loaded document.
If no connection is established or no document is loaded,
this method just returns a memorized status.
@return
True if the status function bar is visible,
false if the status function bar is hidden.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
public boolean isStatusBarVisible()
{
return bStatusBarVisible;
}
// Helper Methods / Internal Methods
// general instance intializer
{
setLayout(new java.awt.BorderLayout());
}
/**
@deprecated
*/
@Override
public void paint( java.awt.Graphics aGraphics )
{
}
/** Adds a single argument to an array of arguments.
If the argument by its name is already in aArguments
it is exchanged and aArguments is returned.
If the argument by its name is not yet in aArguments,
a new array is created, aArgument added and the new
array returned.
*/
private com.sun.star.beans.PropertyValue[] addArgument(
com.sun.star.beans.PropertyValue aArguments[],
final com.sun.star.beans.PropertyValue aArgument )
{
// get number of current arguments
int nNumArgs = 0;
if ( aArguments != null )
nNumArgs = aArguments.length;
// is new argument already set?
for ( int n = 0; n < nNumArgs; ++n )
{
if ( aArguments[n].Name == aArgument.Name )
{
// substitute this argument
aArguments[n] = aArgument;
// return current array
return aArguments;
}
}
// create extended arguments
com.sun.star.beans.PropertyValue[] aExtendedArguments =
new com.sun.star.beans.PropertyValue[ nNumArgs + 1 ];
// copy current arguments
for ( int n = 0; n < nNumArgs; ++n )
aExtendedArguments[n] = aArguments[n];
// add new argument
aExtendedArguments[ nNumArgs ] = aArgument;
// return new arguments
return aExtendedArguments;
}
// Helper Classes
/** Helper class to listen on the connection to learn when it dies.
@internal
*/
private class EventListener
extends Thread
implements
com.sun.star.frame.XTerminateListener
{
String aTag;
EventListener( String aTag )
throws NoConnectionException
{
// init members
this.aTag = aTag;
// listen on a dying connection
iConnection.addEventListener( this );
// listen on a terminating OOo
getOOoDesktop().addTerminateListener( this );
// start this thread as a daemon
setDaemon( true );
start();
}
public void end()
{
// do not listen on a dying connection anymore
try {
iConnection.removeEventListener( this );
}
catch ( Throwable aExc ) {}
// do not listen on a terminating OOo anymore
try {
getOOoDesktop().removeTerminateListener( this );
}
catch ( Throwable aExc ) {}
// stop thread
this.interrupt();
}
/// gets called when the connection dies
public void disposing( /*IN*/ com.sun.star.lang.EventObject Source )
{
// empty the OOoBean and cut the connection
stopOOoConnection();
}
/// gets called when the user wants to terminate OOo
public void queryTermination( /*IN*/ com.sun.star.lang.EventObject Event )
throws com.sun.star.frame.TerminationVetoException
{
// disallow termination of OOo while a OOoBean exists
throw new com.sun.star.frame.TerminationVetoException();
}
/// gets called when OOo terminates
public void notifyTermination( /*IN*/ com.sun.star.lang.EventObject Event )
{
// empty the OOoBean and cut the connection
stopOOoConnection();
}
/// watching the connection
@Override
public void run()
{
dbgPrint( "EventListener(" + aTag + ").run()" );
// remote call might hang => watch try
CallWatchThread aCallWatchThread =
new CallWatchThread( nOOoCallTimeOut, "EventListener(" + aTag + ")" );
// continue to trying to connect the OOo instance
long n = 0;
while ( !isInterrupted()
&& iConnection != null
&& iConnection.getComponentContext() != null )
{
dbgPrint( "EventListener(" + aTag + ").running() #" + ++n );
// still alive?
try
{
// an arbitrary (but cheap) call into OOo
iConnection.getComponentContext().getServiceManager();
// call successfully performed, restart watch for next loop
try
{
aCallWatchThread.restart();
}
catch ( InterruptedException aExc )
{
// ignore late interrupt
}
}
catch ( java.lang.RuntimeException aExc )
{
// hung
OfficeConnection iDeadConn = iConnection;
iConnection = null;
iDeadConn.dispose();
}
// sleep
try {
sleep(nOOoCheckCycle);
}
catch ( InterruptedException aExc )
{
dbgPrint("EventListener(" + aTag + ") interrupted.");
// thread can be ended by EvendListener.end();
break;
}
}
}
}
}
com.sun.star.beans.XPropertySet xPropSet =
(com.sun.star.beans.XPropertySet) UnoRuntime.queryInterface(
com.sun.star.beans.XPropertySet.class, aFrame );
com.sun.star.frame.XLayoutManager xLayoutManager =
(com.sun.star.frame.XLayoutManager) UnoRuntime.queryInterface(
com.sun.star.frame.XLayoutManager.class,
xPropSet.getPropertyValue( "LayoutManager" ) );
xLayoutManager.showElement("private:resource/menubar/menubar");
*/
public void setAllBarsVisible( boolean bVisible )
{
bIgnoreVisibility = true;
setMenuBarVisible( bVisible );
setStandardBarVisible( bVisible );
setToolBarVisible( bVisible );
setStatusBarVisible( bVisible );
bIgnoreVisibility = false;
}
/** Applies all tool visiblities to the real thing.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible setAllBarsVisible}.
*/
private void applyToolVisibilities()
{
bIgnoreVisibility = true;
setMenuBarVisible( bMenuBarVisible );
setStandardBarVisible( bStandardBarVisible );
setToolBarVisible( bToolBarVisible );
setStatusBarVisible( bStatusBarVisible );
bIgnoreVisibility = false;
}
/** Helper method to set tool bar visibilty.
@param bNewValue
If false, the tool bar is disabled,
If true, the tool bar is visible.
@deprecated Clients should use the service com.sun.star.frame.LayoutManager,
which can be obtained from a frame, to control toolbars. See also
{@link #setAllBarsVisible}.
*/
private boolean setToolVisible( String aProperty, String aResourceURL,
boolean bOldValue, boolean bNewValue )
throws
InterruptedException
{
// start runtime timeout
CallWatchThread aCallWatchThread =
new CallWatchThread( nOOoCallTimeOut, "setToolVisible" );
// Does a frame exist?
if ( aFrame != null )
{
if ( bIgnoreVisibility || bOldValue != bNewValue )
{
try
{
com.sun.star.beans.XPropertySet xPropSet =
UnoRuntime.queryInterface(
com.sun.star.beans.XPropertySet.class, aFrame );
com.sun.star.frame.XLayoutManager xLayoutManager =
UnoRuntime.queryInterface(
com.sun.star.frame.XLayoutManager.class,
xPropSet.getPropertyValue( "LayoutManager" ) );
if ( bNewValue )
xLayoutManager.showElement( aResourceURL );
else
xLayoutManager.hideElement( aResourceURL );
}
catch ( com.sun.star.beans.UnknownPropertyException aExc )
{
throw new RuntimeException( "not layout manager found" );
}
catch ( com.sun.star.lang.WrappedTargetException aExc )
{
throw new RuntimeException( "not layout manager found" );
}
// notify change
firePropertyChange( aProperty, Boolean.valueOf(bOldValue), Boolean.valueOf(bNewValue) );
}
}
// end runtime timeout
aCallWatchThread.cancel();
// the new value will be stored by caller
return bNewValue;
}
/** Sets the visibility of the menu bar.
Initially the menu bar is visible.