Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: mozilla ::
interface XPluginInstance
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XPluginInstance
Description Allows to controll an office side plugin instance and to communicate with it. This interface is oriented for communication with browsers plugins.

Methods' Summary
start | Starts plugin operation. This is called after a plugin instance is created.
stop | Stops plugin operation. This is called when the user goes to another web page. The XPluginInstance::destroy method is directly called afterwards.
destroy | Destroy the plugin instance. This method is called when it is no longer possible to return to the plugin instance, because it was destroyed by the browser (e.g., window close).
createWindow | Creates a new window for plugin operation.
newStream | Notifies the plugin of a new stream to display.
newURL | Notifies the plugin of a new url to open as document.
getHttpServerURL | Retrieves the URL of the HTTP Loadbalancing Slave.

Methods' Details
start
[oneway] void start(); |  |
Description Starts plugin operation. This is called after a plugin instance is created.
stop
[oneway] void stop(); |  |
Description Stops plugin operation. This is called when the user goes to another web page. The XPluginInstance::destroy method is directly called afterwards.
destroy
[oneway] void destroy(); |  |
Description Destroy the plugin instance. This method is called when it is no longer possible to return to the plugin instance, because it was destroyed by the browser (e.g., window close).
createWindow
[oneway] void createWindow( | [in] any [in] boolean | PlatformParentData, embedded );
Description Creates a new window for plugin operation. Parameter PlatformParentData [in]: platform dependent window data Parameter embedded [in]: selects embedded or full page plugin mode
newStream
[oneway] void newStream( | [in] string [in] string [in] string [in] ::com::sun::star::io::XInputStream [in] any | MIMEDesc, theURL, filter, stream, sessionData );
Description Notifies the plugin of a new stream to display. Parameter MIMEDesc [in]: the MIMEtype of the data stream Parameter theURL [in]: the URL that denotes the stream Parameter filter [in]: a filter string to suggest a component that should handle the document Parameter stream [in]: the data stream Parameter sessiondata [in]: the data specifying the current session
newURL
[oneway] void newURL( | [in] string [in] string [in] string [in] any | MIMEDesc, theURL, filter, sessionData );
Description Notifies the plugin of a new url to open as document. Parameter MIMEDesc [in]: the MIMEtype of the data stream Parameter theURL [in]: the URL to be openend Parameter filter [in]: a filter string to suggest a component that should handle the document Parameter sessiondata [in]: the data specifying the current session
getHttpServerURL
void getHttpServerURL( | [out] string [out] unsigned short [out] string | aHost, aPort, aPrefix );
Description Retrieves the URL of the HTTP Loadbalancing Slave. Parameter aURL [out]: the full qualified host name of the LBS Parameter aPort [out]: the port number Parameter aPrefix [out]: the url prefix to the portal

Top of Page

Copyright © 2003 Sun Microsystems, Inc.