Difference between revisions of "Documentation/DevGuide/JavaBean/API Overview"
From Apache OpenOffice Wiki
< Documentation | DevGuide
| (One intermediate revision by one other user not shown) | |||
| Line 4: | Line 4: | ||
|NextPage=Documentation/DevGuide/JavaBean/Configuring the Office Bean | |NextPage=Documentation/DevGuide/JavaBean/Configuring the Office Bean | ||
}} | }} | ||
| − | {{DISPLAYTITLE:API Overview}} | + | {{Documentation/DevGuideLanguages|Documentation/DevGuide/JavaBean/{{SUBPAGENAME}}}} |
| − | The <tt>OOoBean</tt> offers methods that can be applied to all {{ | + | {{DISPLAYTITLE:API Overview}} |
| + | The <tt>OOoBean</tt> offers methods that can be applied to all {{AOo}} document types. | ||
{|border="1" cellpadding=4 style="border-collapse:collapse;" | {|border="1" cellpadding=4 style="border-collapse:collapse;" | ||
| Line 18: | Line 19: | ||
|- | |- | ||
|<code>setOOoStartTimeOut(...)</code> | |<code>setOOoStartTimeOut(...)</code> | ||
| − | |<code>void</code> - sets the timeout for methods which start {{ | + | |<code>void</code> - sets the timeout for methods which start {{AOo}} |
|- | |- | ||
|<code>setOOoCallTimeOut(...)</code> | |<code>setOOoCallTimeOut(...)</code> | ||
| Line 24: | Line 25: | ||
|- | |- | ||
|<code>SetOOoCheckCycle(...)</code> | |<code>SetOOoCheckCycle(...)</code> | ||
| − | |<code>void</code> - sets repeat period for cyclic {{ | + | |<code>void</code> - sets repeat period for cyclic {{AOo}} alive check |
|- | |- | ||
|<code>setOOoConnection(...)</code> | |<code>setOOoConnection(...)</code> | ||
| − | |<code>void</code> - sets an explicit connection to a {{ | + | |<code>void</code> - sets an explicit connection to a {{AOo}} instance |
|- | |- | ||
|<code>startOOoConnection(...)</code> | |<code>startOOoConnection(...)</code> | ||
| Line 33: | Line 34: | ||
|- | |- | ||
|<code>isOOoConnected()</code> | |<code>isOOoConnected()</code> | ||
| − | |<code>boolean</code> - returns whether the OOoBean is connected to a {{ | + | |<code>boolean</code> - returns whether the OOoBean is connected to a {{AOo}} |
|- | |- | ||
|<code>stopOOoConnection()</code> | |<code>stopOOoConnection()</code> | ||
| − | |<code>void</code> - stops the current connection to {{ | + | |<code>void</code> - stops the current connection to {{AOo}} |
|- | |- | ||
|<code>getOOoConnection()</code> | |<code>getOOoConnection()</code> | ||
| − | |<code>OfficeConnection</code> - returns the current connection to {{ | + | |<code>OfficeConnection</code> - returns the current connection to {{AOo}} |
|- | |- | ||
|<code>getMultiServiceFactory()</code> | |<code>getMultiServiceFactory()</code> | ||
| − | |<idls>com.sun.star.lang.XMultiServiceFactory</idls> -- returns the service factory of the connected {{ | + | |<idls>com.sun.star.lang.XMultiServiceFactory</idls> -- returns the service factory of the connected {{AOo}} |
|- | |- | ||
|<code>getOOoDesktop()</code> | |<code>getOOoDesktop()</code> | ||
| Line 57: | Line 58: | ||
|- | |- | ||
|<code>releaseSystemWindow()</code> | |<code>releaseSystemWindow()</code> | ||
| − | |<code>void</code> -- has to be called before the parent component loses its system window, e.g. before it is removed from its parent | + | |<code>void</code> -- has to be called before the parent component loses its system window, e.g. before it is removed from its parent component |
|- | |- | ||
|<code>loadFromURL()</code> | |<code>loadFromURL()</code> | ||
Latest revision as of 17:29, 21 December 2020
The OOoBean offers methods that can be applied to all Apache OpenOffice document types.
Methods of com.sun.star.comp.beans.OOoBean
| |
|---|---|
OOoBean()
|
constructor - creates an OOoBean with an implicit connection
|
OOoBean(OfficeConnection)
|
constructor - creates an OOoBean with an explicit connection
|
setOOoStartTimeOut(...)
|
void - sets the timeout for methods which start Apache OpenOffice
|
setOOoCallTimeOut(...)
|
void - sets the timeout for other methods
|
SetOOoCheckCycle(...)
|
void - sets repeat period for cyclic Apache OpenOffice alive check
|
setOOoConnection(...)
|
void - sets an explicit connection to a Apache OpenOffice instance
|
startOOoConnection(...)
|
void - starts a connection with an explicit connection URL
|
isOOoConnected()
|
boolean - returns whether the OOoBean is connected to a Apache OpenOffice
|
stopOOoConnection()
|
void - stops the current connection to Apache OpenOffice
|
getOOoConnection()
|
OfficeConnection - returns the current connection to Apache OpenOffice
|
getMultiServiceFactory()
|
XMultiServiceFactory -- returns the service factory of the connected Apache OpenOffice |
getOOoDesktop()
|
XDesktop - returns the desktop object of the connected OpenOffice.org |
clearDocument()
|
void -- resets the Bean to an empty document
|
clear()
|
void - removes the document from the Bean
|
aquireSystemWindow()
|
void - has to be called when the Bean has a parent component which has a valid system window
|
releaseSystemWindow()
|
void -- has to be called before the parent component loses its system window, e.g. before it is removed from its parent component
|
loadFromURL()
|
void -- loads a document into the Bean
|
loadFromStream()
|
void -- loads a document from a Java stream int o the Bean
|
loadFromByteArray()
|
void -- loads a document from a byte array into the Bean
|
storeToURL()
|
void - stores the document in the Bean to an URL
|
storeToStream()
|
void - stores the document in the Bean to a stream
|
storeToByteArray()
|
void - stores the document in the Bean to a byte array
|
getFrame()
|
Frame -- returns a wrapper for Frame
|
getController()
|
Controller -- returns a wrapper for Controller
|
getDocument()
|
Document -- returns a wrapper for OfficeDocument
|
setAllBarsVisible()
|
void - sets visibility of all tool bars, known by this Bean
|
set...BarVisible()
|
void - sets visibility of a specific tool bar
|
is...BarVisible()
|
boolean - returns visibility of a specific tool bar
|
| Content on this page is licensed under the Public Documentation License (PDL). |
