Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

interface XContainerWindowProvider
Description
provides container windows implementing the XWindow interface.

Methods' Summary
createContainerWindow creates a window for the given URL  
Methods' Details
createContainerWindow
XWindow
createContainerWindow( [in] string  URL,
[in] string  WindowType,
[in] XWindowPeer  xParent,
[in] ::com::sun::star::uno::XInterface  xHandler )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
creates a window for the given URL
Parameter URL
is the URL.
Parameter WindowType
Type of Window to be created, for future use, not supported yet
Parameter xParent
a valid XWindowPeer reference which is used as a parent. This parameter must not be null.
Parameter xHandler
is the interface that will be called to handle the Events that are generated by the window (and all controls placed on it) and bound to the handler using a vnd.sun.star.UNO URL specifying a handler method to be called. Usually this will be done directly by the user. xHandler can handle events in two different ways: 1. By supporting the XContainerWindowEventHandler interface. This is a generic interface to accept event notifications. 2. By providing interfaces that directly implement the handler methods to be called. The XContainerWindowProvider implementation then will try to access these events using the ::com::sun::star::beans::IntrospectionIntrospection service. To make this possible the handler implementation also has to support ::com::sun::star::lang::XTypeProvider. If XContainerWindowEventHandler is supported XContainerWindowEventHandler.callHandlerMethod() is always called first to handle the event. Only if the event cannot be handled by XContainerWindowEventHandler (callHandlerMethod() then has to return false) or if XContainerWindowEventHandler is not supported at all the Introspection based access will be used. The Introspection based access tries to call a method named according to the HandlerMethodName specified by a vnd.sun.star.UNO: URL. First a method void HandlerMethodName( [in] com::sun::star::awt::XWindow xWindow, [in] any aEvent ) will be searched. The signature is similar to XContainerWindowEventHandler. callHandlerMethod except for MethodName itself that isn't needed here. For more information about these parameters, see XContainerWindowEventHandler. If this method is found, it will be called, otherwise a method void HandlerMethodName( void ) will be searched and called.
Returns
a window implementing the XWindow interface.
Throws
com::sun::star::lang::IllegalArgumentException if no window for the given URL is found or if the URL is invalid or xParent is null.
See also
XContainerWindowEventHandler
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.