This method causes the office window to be displayed. If no document is loaded and the instance is added to a Java container that is showing, then this method needs not to be called. If later one of the methods loadFromURL, loadFromStream1, or loadFromByteArray is called, then the document is automatically displayed. Should one of the load methods have been called before the Java container was showing, then this method needs to be called after the container window was made visible (java.lang.Component.setVisible(true)).

Another scenario is that an 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.

Exceptions

SystemWindowException:

if no system window can be acquired.

NoConnectionException:

if the connection is not established.

Resets the OOoBean to an empty status. Any loaded document is unloaded, no matter whether it is modified or not. After calling this method, the OOoBean has no office document and no frame anymore. The connection will stay, though. This method works with or without an established connection.

Resets this bean to an empty document. If a document is loaded and the content modified, the changes are dismissed. Otherwise nothing happens. This method is intended to be overridden in derived classes. This implementation simply calls clear.

Parameters

bClearStateToo:boolean

Not only the document content but also the state of the bean, like visibility of child components is cleared.

Annotations

@Deprecated

returns the com::sun::star::frame::Controller of the bean.

Returns:Controller

a Java class which implements all interfaces which the service com::sun::star::frame::Controller implements. Thus, methods can be called directly without queryInterface. This feature might be implemented by UNO or explicitly coded.

Exceptions

NoConnectionException:

if the connection is not established.

returns the com::sun::star::document::OfficeDocument of the bean.

Returns:OfficeDocument

a Java class which implements all interfaces which the service com::sun::star::document::OfficeDocument implements. Thus, methods can be called directly without queryInterface. This feature might be implemented by UNO or explicitly coded.

Exceptions

NoConnectionException:

if the connection is not established.

returns the com::sun::star::frame::Frame of the bean.

Returns:Frame

a Java class which implements all interfaces which the service com::sun::star::frame::Frame implements. Thus, methods can be called directly without queryInterface. This feature might be implemented by UNO or explicitly coded.

Exceptions

NoConnectionException:

if the connection is not established.

Returns the service factory used by this OOoBean instance.

Exceptions

NoConnectionException:

if no connection is established and no default connection can be established.

Returns a connection to an OOo instance. If no connection exists, a default connection will be created. An OfficeConnection can be used to register listeners of type com.sun.star.lang.EventListener, which are notified when the connection to the office dies. One should not call the dispose method, because this may result in receiving com.sun.star.lang.DisposedExceptions when calling stopOOoConnection or other API methods. If other instances share the same connection then they will stop function properly, because they lose their connection as well. The recommended way to end the connection is by calling stopOOoConnection.

Exceptions

NoConnectionException:

if no connection can be established

Returns the XDesktop interface of the OOo instance used by this OOoBean.

Exceptions

NoConnectionException:

if no connection is established and no default connection can be established.

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.

Returns:boolean

True if the menu bar is visible, false if the menu bar is hidden.

Annotations

@Deprecated

Returns true if this OOoBean is connected to an OOo instance, false otherwise.

Annotations

@Deprecated

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.

Returns:boolean

True if the main function bar is visible, false if the main function bar is hidden.

Annotations

@Deprecated

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.

Returns:boolean

True if the status function bar is visible, false if the status function bar is hidden.

Annotations

@Deprecated

Returns the visibility of the tool 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.

Returns:boolean

True if the tool function bar is visible, false if the tool function bar is hidden.

Annotations

@Deprecated

Loads a document from a byte array. See loadFromURL() for further information.

Loads a document from a Java stream. See loadFromURL() for further information.

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.

Exceptions

NoConnectionException:

if no connection can be established.

IOException:

if an IO error occurs reading the resource specified by the URL.

IllegalArgumentException:

if either of the arguments is out of the specified range.

CloseVetoException:

if the currently displayed document cannot be closed because it is still be used, for example it is printed.

Overrides java.awt.Container.paint.

Doc from java.awt.Container.paint.

Paints the container. This forwards the paint to any lightweight components that are children of this container. If this method is reimplemented, super.paint(g) should be called so that lightweight components are properly rendered. If a child component is entirely clipped by the current clipping setting in g, paint() will not be forwarded to that child.

Annotations

@Deprecated

@Override

Implements java.io.Externalizable.readExternal.

Doc from java.io.Externalizable.readExternal.

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Annotations

@Deprecated

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.

Annotations

@Deprecated

Exceptions

SystemWindowException:

if system window is not acquired.

NoConnectionException:

if the connection is not established.

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");
        

Sets visibility of all tool bars known by this OOoBean version. Initially all tool bars are visible. By hiding all tool bars utilizing this method, it is possible to turn just a subset of toolbars on afterwards, no matter whether all available tool bars are known or not.

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.

Annotations

@Deprecated

Sets the visibility of the menu bar. Initially the menu 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.

Parameters

bVisible:boolean

If false, the menu bar is disabled, If true, the menu bar is visible.

Annotations

@Deprecated

Sets the timeout for normal OOO methods calls in milliseconds. This method does not need a connection to an OOo instance.

Sets the period length in milliseconds to check the OOo connection. This method does not need a connection to an OOo instance.

Sets the timeout for methods which launch OOo in milliseconds. This method does not need a connection to an OOo instance.

Sets the main function bar visibility. 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.

Parameters

bVisible:boolean

If false, the main function bar is disabled, If true, the main function bar is visible.

Annotations

@Deprecated

Sets the status function bar visibility. 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.

Parameters

bVisible:boolean

If false, the status function bar is disabled, If true, the status function bar is visible.

Annotations

@Deprecated

Sets the tool function bar visibility. 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.

Parameters

bVisible:boolean

If false, the tool function bar is disabled, If true, the tool function bar is visible.

Annotations

@Deprecated

Starts a connection to an OOo instance which is launched if not running.

Exceptions

HasConnectionException:

if a connection was already established.

NoConnectionException:

if the specified connection cannot be established

Disconnects from the connected OOo instance. If there was no connection yet or anymore, this method can be called anyway. When the OOoBean is displayed in an applet by a web browser, then this method must be called from within java.applet.Applet.stop.

Stores a document to a byte array. See storeToURL for further information.

See Also

storeToURL

Stores a document to a stream. See storeToURL for further information.

See Also

storeToURL

Stores a document to the given URL.

Due due a bug (50651) calling this method may cause the office to crash, when at the same time the office writes a backup of the document. This bug also affects storeToByteArray and storeToStream. The workaround is to start the office with the option --norestore, which disables the automatic backup and recovery mechanism. OOoBean offers currently no supported way of providing startup options for OOo. But it is possible to set a Java property when starting Java, which is examined by OOoBean:

    java -Dcom.sun.star.officebean.Options=--norestore  ...

Exceptions

NoConnectionException:

if no connection is established.

IOException:

if an IO error occurs reading the resource specified by the URL.

IllegalArgumentException:

if either of the arguments is out of the specified range.

NoDocumentException:

if no document is loaded

Implements java.io.Externalizable.writeExternal.

Doc from java.io.Externalizable.writeExternal.

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Annotations

@Deprecated