:: com :: sun :: star :: frame ::
|
service ProtocolHandler |
- Description
- special dispatch provider registered for URL protocols
The generic dispatch mechanism on a Frame
search for such registered protocol handler and use it if it agrees with
the dispatched URL.
Supported URLs must match follow format: :
If a handler provides optional arguments ("?") or jump marks ("#") depends from his
defintion and implementation. The generic dispatch provider will use registered
URL pattern to detect right handler.
- Developers Guide
- WritingUNO - Implementation
|
Exported Interfaces - Summary |
XDispatchProvider |
used from the generic dispatch mechanism of the frame, to ask ProtocolHandler
for his agreement for the dispatched URL
(details)
|
::com::sun::star::lang::XInitialization |
initialize the new handler instance with some context informations
(details)
|
Exported Interfaces - Details |
XDispatchProvider
- Description
- used from the generic dispatch mechanism of the frame, to ask ProtocolHandler
for his agreement for the dispatched URL
Such asked handler can agree by returning itself or a special sub dispatch object, which
can handle the given URL. Of course he can disagree with it by returning an empty reference.
|
|
::com::sun::star::lang::XInitialization
- Usage Restrictions
- optional
- Description
- initialize the new handler instance with some context informations
Sometimes it can be usefull for a handler object, to know something about the
environment, in which it runs - especily the frame. For this case the generic
code (which uses the handler) will ask for this optional interface and use it, if it exist.
Following parameters are passed to the service:
- sequence< any >[0] => the frame for which this ProtocolHandler was created [com.sun.star.frame.XFrame]
Please note: if this mechanism is used it seams not usefull (nor possible) to implement a ProtocolHandler
as a singleton. Otherwhise the implementation can't distinguish between different environments
and her corresponding dispatch requests.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.